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:
Content: Measurement , DimensionCoded (Type: DimensionCode) , DimensionCodedOther (Type: string)?
Description: The Dimension element is quantitative physical characteristic.
Measurement is the quantitative value and unit of measure for the dimension.DimensionCoded contains a code qualifying the quantitative physical characteristic as being described by the dimension.DimensionCodedOther is used to specify a non-standard DimensionCode. This element is mandatory if the value of DimensionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Dimension+
Description: The ListOfDimension element is a container for a list of one or more dimension elements.
Dimension is quantitative physical characteristic.Description:
This code identifies the attribute measured. This code list is derived from EDIFACT 6313 (Measured attribute code)
Value: Enumeration, including:
Description:
This identifies the type of document. This code list is derived from EDIFACT 1001 (Document Code Name).
Value: Enumeration, including:
Content: CertificateAuthority (Type: string)? , ListOfEncryptedField
Description: The EncryptedInfo element contains a placeholder to store customer or bank specific encrypted fields.
CertificateAuthority contains the payer's certificate of authority or digital signature which will be used by the financial institution to verify the origins of the document and validate the payment.ListOfEncryptedField is a a list of encrypted fields.Content: EncryptedField+
Description: The ListOfEncryptedField element is a a list of encrypted fields.
EncryptedField contains a generic structure to store encrypted data.Content: Sequence (Type: int)? , EncryptedData (Type: string)
Description: The EncryptedField element contains a generic structure to store encrypted data.
Sequence contains a counter to identify a specific encrypted field in a given set of encrypted fields.EncryptedData contains the encrypted data.Description:
This code identifies the relationship of equipment to carrier or ownership of equipment. This code list is derived from X12 102 (Ownership code)
Value: Enumeration, including:
Description:
This code identifies the party that is the provider of the equipment. This code list is derived from EDIFACT 8077 (Equipment supplier code)
Value: Enumeration, including:
Description:
This code identifies the size and type of the equipment. This code list is derived from EDIFACT 8155 (Equipment size and type description code) and X12 40 (Equipment description code)
Value: Enumeration, including:
Description:
This code identifies the status of the equipment. This code list is derived from EDIFACT 8249
Value: Enumeration, including:
Content: CompletionText (Type: string) , CompletionMsg (Type: LanguageString) , Severity , ListOfParameter? , MinRetrySecs (Type: int)? , SwVendorErrorRef (Type: string)?
Description: The ErrorInfo element is used by the receiving application to return complete information about errors encountered during processing of a message.
CompletionText is the error code produced. A complete list of error codes is available elsewhere, specific to the message that uses this module.CompletionMsg is the error message.Severity states the severity of the error encountered.ListOfParameter is an optional field that can be used to pass extra information to caller about an error. In a way, the motivation of this field is similar to the IOTP's PackagedContent concept. For example, a buyer and a supplier can agree that under the situation where the supplier does not have enough stock, it will pass these three parameters: Param1 SKU#, Param2 Buyer Requested Delivery Date, Param3 The date when supplier will be able to fulfil the order.MinRetrySecs is an optional field used to specify the number of seconds that a caller has to wait before sending the retry request. This field is usually used by an error that has severity=Transient.SwVendorErrorRef is the optional software vendor Error Reference and is used to specify the exact location where the error occurs. It should contain information that enable software vendor to trace back the exact location of the code that generate this code.Content: Parameter (Type: string)+
Description: The ListOfParameter element is a collection of one or more Parameter elements.
Parameter is used to communicate extra information about an error.Content: ErrorInfo+
Description: The ListOfErrorInfo element is a collection of one or more ErrorInfo elements.
ErrorInfo is used by the receiving application to return complete information about errors encountered during processing of a message.Content: SeverityCoded (Type: SeverityCode) , SeverityCodedOther (Type: string)?
Description: The Severity element is a container for stating the severity of an error.
SeverityCoded contains a code qualifying the type of severity.SeverityCodedOther is used to specify a non-standard SeverityCode. This element is mandatory if the value of SeverityCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code indicates the severity of an error.
Value: Enumeration, including:
Content: AccountDetail , FinancialInstitution
Description: The FIAccountDetail element is a container for the financial institution and account details.
AccountDetail contains information pertinent to identifying a financial institution and an account within the financial institution.FinancialInstitution identifies the financial institution and branch that holds the account.Content: AccountDetail? , FinancialInstitution
Description: The FIAccount element describes account information including account numbers, institution and branch.
AccountDetail contains information pertinent to identifying an account within a financial institution.FinancialInstitution identifies the financial institution and branch that holds the account.Content: AccountID (Type: string) , SecondaryAccountID (Type: string)? , IBAN (Type: string)? , AccountControlKey (Type: string)? , AccountTypeCoded (Type: AccountTypeCode) , AccountTypeCodedOther (Type: string)? , AccountName1 (Type: string) , AccountName2 (Type: string)? , Currency? , AccountReferences (Type: ListOfReferenceCoded)?
Description: The AccountDetail element contains information pertinent to identifying an account within a financial institution.
AccountID specifies the account number or identifier for the account.SecondaryAccountID specifies a secondary account number to identify the account.IBAN specifies an IBAN number (International Bank Account Number).AccountControlKey specifies the control number to uniquely identify the account at the financial institution.AccountTypeCoded contains a code qualifying the type of account.AccountTypeCodedOther is used to provide a non-standard AccountTypeCode. This element is mandatory if the value of AccountTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.AccountName1 specifies the main account holder of the account.AccountName2 specifies a secondary name/holder on the account.Currency specifies the currency that applies to the account.AccountReferences contains a list of coded references to specify an identifier or name associated with the account.Content: FinancialInstitutionID (Type: string) , FinancialInstitutionName (Type: string) , FIBranchID (Type: string)? , FIBranchName (Type: string)? , FIBranchCity (Type: string)? , FIBranchCountry (Type: Country)?
Description: The FinancialInstitution element identifies a financial institution and branch.
FinancialInstitutionID identifies the financial institution by code.FinancialInstitutionName identifies the financial institution by name.FIBranchID identifies the branch of the financial institution by the branch code.FIBranchName identifies the name of the branch of the financial institution.FIBranchCity identifies the city where the financial institution branch is located.FIBranchCountry identifies the country where the financial institution branch is based. This contains an ISO country code list.Description:
This code indicates the type of account. This codelist is derived from X12 569 (Account Number Qualifier)
Value: Enumeration, including:
Content: FXRateRequestHeader , ListOfFXRateRequestDetail? , FXRateRequestSummary?
Description: The FXRateRequest element . The foreign exchange rate request document enables payers to retrieve a foreign exchange quote from a financial institution. The payer can initiate a Foreign Exchange Request to get a rate quote and quote reference number on two specific currency pairs. The payer will review the quote information and then decide whether this quote is satisfactory. This will allow the payer the capability to pay for goods and services in a foreign currency when they enact a Payment Request.
FXRateRequestHeader contains all header-related data associated with the FXRateRequest document.ListOfFXRateRequestDetail contains a list of FXRateRequestDetails. Details are optional in the case where an indicative FX rate is being requested. This is specified by the IndicativeIndicator in the header.FXRateRequestSummary contains summary related information for the FXRateRequest document.Content: FXRateRequestDetail+
Description: The ListOfFXRateRequestDetail element contains a list of FXRateRequestDetails. Details are optional in the case where an indicative FX rate is being requested. This is specified by the IndicativeIndicator in the header.
FXRateRequestDetail contains detailed information related to the FX rates being requested.Content: SequenceNumber (Type: int)? , RateQuoteID (Type: Reference)? , ReferenceCurrency (Type: Currency) , TargetCurrency (Type: Currency) , SettlementAmount (Type: MonetaryValue) , DebitAmount (Type: MonetaryValue)? , CreditAmount (Type: MonetaryValue)? , OriginatingFinancialInstitution (Type: FIAccountDetail)? , CardInfo? , ComputationalMethodCoded (Type: ComputationalMethodCode)? , ComputationalMethodCodedOther (Type: string)? , FXQuoteTypeCoded (Type: FXQuoteTypeCode)? , FXQuoteTypeCodedOther (Type: string)? , ListOfReference? , PayeeParty (Type: Party)? , PayerParty? , FXRateRequestNote (Type: string)?
Description: The FXRateRequestDetail element contains detailed information related to the FX rates being requested.
SequenceNumber contains the sequence number for the rate quote request.RateQuoteID identifies the unique user identifier for the FXRateRequest.ReferenceCurrency specifies the reference currency of the rate of exchange.TargetCurrency indicates the target currency of the rate of exchange.SettlementAmount contains the monetary amount to be transacted.DebitAmount contains the amount to be debited from the payers account.CreditAmount contains the amount to be credited to the payees account.OriginatingFinancialInstitution contains financial details relating to the customer's deposit account.CardInfo contains details for payments made via credit card. This includes credit card number, card type, card holder name, expiration date, and other pertinent information.ComputationalMethodCoded indicates the means by which the requester would like to have the rate quoted.ComputationalMethodCodedOther is used to provide a non-standard ComputationalMethodCode. This element is mandatory if the value of ComputationalMethodCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FXQuoteTypeCoded contains the coded FXRate quote type.FXQuoteTypeCodedOther is used to provide a non-standard FXQuoteTypeCode. This element is mandatory if the value of FXQuoteTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfReference contains additional customer defined reference information.PayeeParty describes the beneficiary of the payment and their identification number.PayerParty describes who is responsible for payment. This is assumed to also be the sender of the document. The PayerParty includes an optional CertificateAuthority field to hold the payer's digital signature or certificate of authority.FXRateRequestNote contains any free-form text pertinent for other FXRateRequest related 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.Content: FXRateRequestID (Type: Reference) , FXRateRequestIssueDate (Type: datetime) , Language , PaymentMeanCoded (Type: PaymentMeanCode)? , PaymentMeanCodedOther (Type: string)? , PayerParty? , IndicativeIndicator (Type: boolean) , GeneralNote (Type: string)?
Description: The FXRateRequestHeader element contains all header-related data associated with the FXRateRequest document.
FXRateRequestID specifies the unique identifier for the FXRateRequest document.FXRateRequestIssueDate indicates the date the FXRateRequest document is transmitted.Language identifies the language of the FXRateRequest.PaymentMeanCoded indicates the intended method of payment.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.PayerParty contains information to identify the payer. PayerParty includes an optional CertificateAuthority field to hold the payer's digital signature or certificate of authority.IndicativeIndicator specifies whether or not the request is for an indicative rate quote. If TRUE, then the detail section of the FXRateRequest document is not required.GeneralNote contains any free-form text pertinent to the entire FXRateRequest 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: NumberOfFXRateRequest (Type: int)?
Description: The FXRateRequestSummary element contains summary related information for the FXRateRequest document.
NumberOfFXRateRequest contains the total number of FXRates requested in this document.Content: FXRateResponseHeader , ListOfFXRateResponseDetail , FXRateResponseSummary (Type: FXRateRequestSummary)?
Description: The FXRateResponse element . The Financial Institution sends this document to the Payer to provide a foreign exchange rate quote to obtain the currency needed to settle the payment.
FXRateResponseHeader contains all data associated with the FXRateResponse document.ListOfFXRateResponseDetail contains a list of FXRateRequestDetail for a FX rate quote.FXRateResponseSummary contains summary related information for the FXRateResponse document.Content: FXRateResponseDetail+
Description: The ListOfFXRateResponseDetail element contains a list of FXRateRequestDetail for a FX rate quote.
FXRateResponseDetail contains detailed information pertaining to the FXRateResponse. This includes payment document information containing payment-related information at the line item level.Content: SequenceNumber (Type: int)? , ReferenceCurrency (Type: Currency) , ComputationalMethodCoded (Type: ComputationalMethodCode)? , ComputationalMethodCodedOther (Type: string)? , FXRate (Type: Decimal19_9) , InverseFXRate (Type: Decimal19_9)? , PayerParty? , (IndicativeRateDetail | SpotRateDetail) , ListOfPaymentReference (Type: ListOfReference)? , ListOfOtherPaymentInfo (Type: ListOfNameValuePair)? , ListOfPaymentException? , CertificateAuthority (Type: string)? , FXRateResponseNote (Type: string)?
Description: The FXRateResponseDetail element contains detailed information pertaining to the FXRateResponse. This includes payment document information containing payment-related information at the line item level.
SequenceNumber tracks the payment document associated with the FXRateResponse in the case where the payment request contains more than one payment document.ReferenceCurrency contains the reference currency of the rate of exchange (from currency).ComputationalMethodCoded contains the rules for the conversion.ComputationalMethodCodedOther is used to provide a non-standard ComputationalMethodCode. This element is mandatory if the value of ComputationalMethodCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FXRate contains the FX rate quoted (Direct/Multiply).InverseFXRate contains the FX rate quoted (Indirect/Divide).PayerParty describes who is responsible for payment. This is usually assumed to be the sender of the request document. The PayerParty includes an optional CertificateAuthority field to hold the payer's digital signature or certificate of authority.IndicativeRateDetail contains fields and elements specific to the indicate rate quote. This structure is provided when the IndicativeIndicator is true.SpotRateDetail contains fields and elements specific to the spot rate quote. This structure is provided when the IndicativeIndicator is false.ListOfPaymentReference contains payment related reference detail such as invoice numbers, purchase order numbers, dates etc.ListOfOtherPaymentInfo contains a list of additional customer providing payment information.ListOfPaymentException contains a list of exception codes relating to the FXRate request document.CertificateAuthority specifies an element to contain the digital signature of the financial institution.FXRateResponseNote contains any free-form text pertinent to the entire FXRateResponse. 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: FXRateResponseID (Type: Reference) , FXRateResponseIssueDate (Type: datetime) , FXRateRequestID (Type: Reference) , Language , SendingParty (Type: PayerParty)? , IndicativeIndicator (Type: boolean) , GeneralNote (Type: string)?
Description: The FXRateResponseHeader element contains all data associated with the FXRateResponse document.
FXRateResponseID specifies the unique identifier for the FXRateResponse document.FXRateResponseIssueDate indicates the date the FXRateResponse document is transmitted.FXRateRequestID contains the unique identifier for the FXRateRequest document.Language identifies the language of the FXRateResponse.SendingParty describes the sender of the document. This is usually assumed to be the financial institution. This element includes an optional CertificateAuthority field to hold the sender's digital signature or certificate of authority.IndicativeIndicator contains a boolean indicator to specify whether or not the FXRateResponse contains indicative rate quotes.GeneralNote contains any free-form text pertinent to the entire FXRateResponse 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: Fee+
Description: The ListOfFee element contains a list of fees and amounts pertinent to the spot FX rate quote.
Fee holds the description and amount elements for the Fee.Content: FeeType (Type: string)? , FeeValue (Type: MonetaryValue)?
Description: The Fee element holds the description and amount elements for the fee.
FeeType contains the description of the Fee.FeeValue contains the amount of the Fee described in FeeType.Content: ChargeRegulationCoded (Type: ChargeRegulationCode) , ChargeRegulationCodedOther (Type: string)? , FeeAmount (Type: MonetaryValue)? , ChargeAccount (Type: AccountDetail)?
Description: The FinancialChargesAllocation element contains information pertaining to how payment of fees will be allocated between partners.
ChargeRegulationCoded specifies the party responsible for the payment of fees.ChargeRegulationCodedOther is used to provide a non-standard ChargeRegulationCode. This element is mandatory if the value of ChargeRegulationCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FeeAmount indicates the monetary amount of the fee.ChargeAccount specifies the bank account from which the fees should be paid.Content: OriginatingFinancialInstitution (Type: FIAccountDetail) , ReceivingFinancialInstitution (Type: FIAccountDetail) , ListOfFinancialInstitutions (Type: ListOfFIAccount)?
Description: The FinancialInstitutionDetail element contains specifications for the financial institution information which includes both account specific detail (i.e., account ID, account type, account holder) and financial institution specific detail (i.e., bank ID, branch ID). Financial institution information must be provided for the originating bank and associated account detail and the receiving bank and associated account detail.
OriginatingFinancialInstitution contains the financial institution account information of the originating bank. The account detail and financial institution detail are required.ReceivingFinancialInstitution contains the financial institution account information for the receiving bank. The account detail and financial institution detail are required.ListOfFinancialInstitutions contains a list of other financial institutions or intermediary banks associated with the payment request. The financial institution detail is required; the account detail is optional.Description:
This code identifies the release frequency of the line item. This code list is derived from X12 681 (Timing Qualifier)
Value: Enumeration, including:
Content: ListOfHazardousIdentifiers? , HazardClassCoded (Type: HazardClassCode)? , HazardClassCodedOther (Type: string)? , HazardousPlacardInformation? , HazardousReferences (Type: ListOfReferenceCoded)? , HazardousContact (Type: Contact)? , HazardNote (Type: string)? , UNDGNum (Type: int)? , HazardousTemperatures? , HazardousShipmentInformation? , EMSNum (Type: string)? , Mfag (Type: string)?
Description: The Hazardous element specifies the hazardous information required for safe handling of an item or package.
ListOfHazardousIdentifiers is a list of identifiers that are in reference to the hazardous material being described.HazardClassCoded is a code qualifying hazardous class. Values are primary or secondary.HazardClassCodedOther is used to specify a non-standard HazardClassCode. This element is mandatory if the value of HazardClassCoded is 'Other'. These codes should not contain white space unless absolutely necessary.HazardousPlacardInformation is used to specify the placard information required on the means of transport or shipping information.HazardousReferences is used to transmit specific hazardous material reference numbers.HazardousContact is the seller's contact for more information on the hazardous information.HazardNote provides additional information regarding the hazardous substance. (Can be used to hold information such as the type of regulatory requirements that apply to a description, e.g. N.O.S.).UNDGNum contains a unique serial number assigned within the United Nations to substances and articles contained in a list of the dangerous goods most commonly carried.HazardousTemperatures contains the various temperatures that relate to the item or package, such as flashpoint, control, and emergency.HazardousShipmentInformation holds information related to the shipping and packaging of hazardous goods.EMSNum is the emergency procedures for ships carrying dangerous goods.Mfag is the medical first aid guide.Content: HazardousRegulationsCoded (Type: AgencyCode) , HazardousRegulationsCodedOther (Type: string)? , HazardCode (Type: string)? , CodeExtension (Type: string)? , CodeVersion (Type: string)? , HazardOfficialText (Type: string)? , TremCardNum (Type: string)?
Description: The HazardousIdentifiers element are identifiers that describe specifics of the hazardous codes associated with an item or packaging.
HazardousRegulationsCoded is the agency that assigns the hazard code.HazardousRegulationsCodedOther is used to provide a non-standard HazardousRegulationsCode. This element is mandatory if the value of HazardousRegulationsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.HazardCode is the value of the hazard code.CodeExtension is an extension to the hazardous packaging code above. Can also be used to hold additional code values such as a Waste Characteristics Code in conjunction with an EPA Waste Stream code.CodeVersion is the version of the hazardous code.HazardOfficialText is the official name of the hazardous substance.TremCardNum is the identification of a transport emergency card, giving advice for emergency actions. Can be used for the identity number of a specific hazardous emergency response plan that is assigned by the Director General of Canada.Content: HazardousIdentifiers+
Description: The ListOfHazardousIdentifiers element is a list of identifiers that are in reference to the hazardous material being described.
HazardousIdentifiers are identifiers that describe specifics of the hazardous codes associated with an item or packaging.Content: HazardousPlacardIdentification (Type: string)? , HazardousPlacardText (Type: string)?
Description: The HazardousPlacardInformation element is used to specify the placard information required on the means of transport or shipping information.
HazardousPlacardIdentification is the placard notation corresponding to the hazard class of the hazardous commodity. Can also be the hazard identification number of the orange placard (upper part) required on the means of transport.HazardousPlacardText is used for the placard endorsement that is to be shown on the shipping papers for the hazardous commodity. Can also be used for the number of the orange placard (lower part) required on the means of transport.Content: Flashpoint (Type: Quantity)? , Emergency (Type: Quantity)? , Control (Type: Quantity)? , ListOfTemperatureCoded (Type: ListOfDimension)?
Description: The HazardousTemperatures element contains the various temperatures that relate to the item or package, such as flashpoint, control, and emergency.
Flashpoint is the lowest temperature at which the vapor of a combustible liquid can be made to ignite momentarily in air.Emergency is the temperature at which emergency procedures apply for the disposal of temperature-controlled goods.Control is the maximum temperature at which certain products can be safely transported.ListOfTemperatureCoded holds a list of one or more temperatures.Content: HazardPackingCoded (Type: HazardPackingCode)? , HazardPackingCodedOther (Type: string)? , HazardousShipmentCoded (Type: HazardousShipmentCode)? , HazardousShipmentCodedOther (Type: string)? , HazardousShipmentNote (Type: string)? , HazardousZoneCoded (Type: HazardousZoneCode)? , HazardousZoneCodedOther (Type: string)?
Description: The HazardousShipmentInformation element holds information related to the shipping and packaging of hazardous goods.
HazardPackingCoded identifies the hazardous packaging information. Minor Damage is equal to III.HazardPackingCodedOther is used to provide a non-standard HazardPackingCode. This element is mandatory if the value of HazardPackingCoded is 'Other'. These codes should not contain white space unless absolutely necessary.HazardousShipmentCoded indicates the type of information being passed so that a receiver may format a description of hazardous commodity movements that meets regulatory requirements.HazardousShipmentCodedOther is used to provide a non-standard HazardousShipmentCode. This element is mandatory if the value of HazardousShipmentCoded is 'Other'. These codes should not contain white space unless absolutely necessary.HazardousShipmentNote is used to provide specific information required by law for hazardous material shipments or any free form text relating to hazardous shipments.HazardousZoneCoded is used to specify the Department of Transportation assigned zone designating the Inhalation Toxicity Hazard Zone.HazardousZoneCodedOther is used to provide a non-standard HazardousZoneCode. This element is mandatory if the value of HazardousZoneCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the packing criteria for hazardous materials as assigned by IATA/IMDB/ADR/RID. This code list is derived from EDIFACT 8339 (Packing group code)
Value: Enumeration, including:
Description:
This code identifies the hazardous class.
Value: Enumeration, including:
Description:
This code identifies the Department of Transportation assigned zone designating the inhalation toxicity hazard zone. This is code list is derived from X12 1023 (Hazard zone code)
Value: Enumeration, including:
Description:
This code identifies the type of information being passed so that a receiver may format a description of hazardous commodity movements that meet regulatory requirements. This code list is derived from X12 808 (Hazardous material shipment information qualifier)
Value: Enumeration, including:
Content: Hazardous+
Description: The ListOfHazardous element contains one or more Hazardous elements.
Hazardous specifies the hazardous information required for safe handling of an item or package.Content: PrimaryID? , ListOfTradingPartnerID?
Description: The Identifications element is an identification structure containing all possibilities of identifying a trading partner or a contact and also enabling referencing to one of those. At least one of the elements must be used.
PrimaryID contains a unique TradingPartnerID created by the marketplace. This ID is globally unique.ListOfTradingPartnerID contains a list of one or more TradingPartnerID created by the marketplace.Content: Agency , Ident (Type: string)
Description: The Identifier element is used to provide an identification number that is assigned by a standards agency.
Agency identifies the standards agency, and if necessary, the codelist which the identification belongs to.Ident holds the identification number assigned by the agency.Content: Identifier+
Description: The ListOfIdentifier element contains one or more Identifier elements.
Identifier is used to provide an identification number that is assigned by a standards agency.Content: CurrencyDecimalPlaces (Type: int)? , CurrencyAvailabilityCheckList? , IndicativeRateRetrievedDate (Type: datetime)? , CurrentDateTime (Type: datetime)?
Description: The IndicativeRateDetail element contains fields and elements specific to the indicate rate quote. This structure is provided when the IndicativeIndicator is true.
CurrencyDecimalPlaces contains the number of decimal places that will be used to quote the currency.CurrencyAvailabilityCheckList indicates multiple types of payment services available for the exchange currency.IndicativeRateRetrievedDate contains the date and time that the indicative rate was quoted.CurrentDateTime contains the current date and time.Content: FundsTransferIndicator (Type: boolean)? , RemoteCheckIndicator (Type: boolean)? , OnsiteCheckIndicator (Type: boolean)? , ACHIndicator (Type: boolean)? , RemitCurrencyIndicator (Type: boolean)? , OtherPaymentServiceNote (Type: string)?
Description: The CurrencyAvailabilityCheckList element indicates multiple types of payment services available for the exchange currency.
FundsTransferIndicator indicates whether payment services for funds transfer is available.RemoteCheckIndicator indicates whether payment services for remote checks is available.OnsiteCheckIndicator indicates whether payment services for onsite checks is available.ACHIndicator indicates whether payment services for ACH is available.RemitCurrencyIndicator indicates whether payment services for remit currency is available.OtherPaymentServiceNote contains a general note field to capture details pertaining to other payment services provided by the financial institution.Description:
This code identifies whether an allowance or charge applies. This code list is derived from EDIFACT 5463 (Allowance) and X12 248 (Allowance Or Charge Indicator)
Value: Enumeration, including:
Description:
This code identifies the industry sector for a given company. This code list is derived from EDIFACT 7293(Sector/subject identification qualifier)
Value: Enumeration, including:
Content: InvoiceHeader , InvoiceDetail , InvoiceSummary?
Description: The Invoice element comprises the creation of an invoice that is sent from a seller to a buyer for payment for the goods or services detailed in the invoice supplied under conditions agreed between buyer and seller. An invoice may refer to goods, items or services related to one or more orders. An invoice may contain references to payment terms and transport information.
InvoiceHeader contains the header information of the Invoice.InvoiceDetail contains the line item and package details of the Invoice.InvoiceSummary contains the summary information of the Invoice.Content: InvoiceDueDate (Type: datetime)? , ExpectedShipToDateTime (Type: datetime)? , ActualShipToDateTime (Type: datetime)? , ReceiptDateTime (Type: datetime)? , TaxPeriod (Type: ValidityDates)? , InvoicingPeriod (Type: ValidityDates)? , ListOfOtherInvoiceDates (Type: ListOfDateCoded)?
Description: The InvoiceDates element contains pertinent dates for the invoice. These may be overwritten at a lower level within the structure InvoiceDetail.
InvoiceDueDate holds the date that the invoice is due for payment.ExpectedShipToDateTime holds the date the goods are expected to be shipped.ActualShipToDateTime holds the date the goods were shipped.ReceiptDateTime holds the date the goods were received at their destination.TaxPeriod contains the tax period for the invoice.InvoicingPeriod contains the period for which the invoice is issued.ListOfOtherInvoiceDates contains all other dates for the invoice that have not been explicitly defined as the content of other elements.Content: ListOfInvoiceItemDetail , ListOfPackageDetail?
Description: The InvoiceDetail element contains the line item and package details of the Invoice.
ListOfInvoiceItemDetail contains a list of line items for the Invoice.ListOfPackageDetail holds a list of packaging information at the item detail level.Content: InvoiceNumber (Type: Reference) , InvoiceIssueDate (Type: datetime) , TaxPointDate (Type: datetime)? , InvoiceReferences* , InvoicePurpose , InvoiceType , InvoiceCurrency (Type: Currency)? , PaymentCurrency (Type: Currency)? , ListOfRateOfExchangeDetail? , TaxAccountingCurrency (Type: Currency)? , InvoiceLanguage (Type: Language) , InvoiceTaxReference (Type: TaxReference)? , InvoiceMedium? , AllowOrChargeTreatment? , InvoiceDates? , InvoiceParty , ListOfTransportRouting? , InvoiceTermsOfDelivery (Type: TermsOfDelivery)? , InvoicePaymentInstructions (Type: PaymentInstructions)? , InvoiceAllowancesOrCharges (Type: ListOfAllowOrCharge)? , InvoiceHeaderNote (Type: string)? , ListOfStructuredNote? , InvoiceHeaderAttachments (Type: ListOfAttachment)?
Description: The InvoiceHeader element contains the header information of the Invoice.
InvoiceNumber holds the unique number that identifies the Invoice, typically according to the system that generated the Invoice.InvoiceIssueDate holds a time stamp provided by the application that created the Invoice document.TaxPointDate is used to specify the tax point date for tax accounting purpose. This element is mandatory if the tax point date is not the same as the InvoiceIssueDate.InvoiceReferences contains external references to the Invoice that are important to the processing and use of the Invoice.InvoicePurpose defines the purpose of the Invoice.InvoiceType identifies the type of the Invoice being transmitted.InvoiceCurrency identifies the default currency of the Invoice. This may be overwritten at a lower level within the structure InvoiceDetail.PaymentCurrency identifies the currency for the payment of the Invoice. This element is used when the payment currency is not the same as the InvoiceCurrency.ListOfRateOfExchangeDetail contains one or more elements detailing information on the rate of exchange between currencies.TaxAccountingCurrency identifies the currency to be used for tax accounting purposes. This element is mandatory when the tax accounting currency is not the same as the InvoiceCurrency.InvoiceLanguage identifies the language of the Invoice.InvoiceTaxReference is a reference to the tax information relevant to the Invoice.InvoiceMedium is the method of communicating the Invoice.AllowOrChargeTreatment contains information relating to the calculation of the allowance or charges and the calculation of the price.InvoiceDates contains pertinent dates for the Invoice. These may be overwritten at a lower level within the structure InvoiceDetail.InvoiceParty contains information on the parties to the Invoice, including unique ID's and address information.ListOfTransportRouting provides information on the movement of the goods, including details on carrier(s) equipment locations and dates.InvoiceTermsOfDelivery contains information on the terms of delivery for the Invoice.InvoicePaymentInstructions contains information on the payment instructions for the Invoice.InvoiceAllowancesOrCharges contains a list of the allowances, discounts or charges applicable for the whole invoice.InvoiceHeaderNote contains any free form text pertinent to the entire invoice or to the Invoice 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 line item 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.InvoiceHeaderAttachments holds a list of attachments applicable to the entire Invoice, or to a large part of the invoice it describes.Content: InvoiceBaseItemDetail , InvoicePricingDetail , LineItemDates (Type: InvoiceDates)? , OtherInvoiceParties? , DeliveryDetail? , LineItemNote (Type: string)? , ListOfStructuredNote? , LineItemAttachments (Type: ListOfAttachment)?
Description: The InvoiceItemDetail element contains the item detail information for the Invoice.
InvoiceBaseItemDetail contains the identifying and descriptive information for the line items in the Invoice.InvoicePricingDetail contains the information on the basic unit prices for the line item.LineItemDates contains pertinent dates for the line item.OtherInvoiceParties contains information on other parties for the line item, including unique ID's and address information.DeliveryDetail is used to specify the scheduling information for a distinct set of ShipFrom party, ShipTo party, and transport information for the 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 line item 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.LineItemAttachments holds a list of attachments applicable to the line item, or to a large part of the line item it describes.Content: InvoiceItemDetail+
Description: The ListOfInvoiceItemDetail element contains a list of line items for the Invoice.
InvoiceItemDetail contains the item detail information for the Invoice.Extends: BaseItemDetail
Description: The InvoiceBaseItemDetail element contains the identifying and descriptive information for the line items in the Invoice.
LineItemReferences contains external references that are pertinent to the invoice at line item level if different to the header level.ExceptionQuantities identifies if invoiced quantity is different to the ordered quantity.Content: Ordered (Type: Quantity)? , Damaged (Type: Quantity)? , Unusable (Type: Quantity)? , Returned (Type: Quantity)? , ShippedToDate (Type: Quantity)?
Description: The ExceptionQuantities element informs why the invoiced quantity is different to the ordered.
Ordered holds the quantity ordered.Damaged holds the quantity received that was damaged.Unusable holds the quantity received that was unusable.Returned holds the quantity that has been returned.ShippedToDate holds the total quantity shipped for the line item (partial deliveries).Extends: PricingDetail
Description: The InvoicePricingDetail element contains the information on the basic unit prices for the line item.
InvoiceCurrencyTotalValue holds the total value in the invoice currency for the line item.PaymentCurrencyTotalValue holds the total value in the payment currency for the line item. This element is used when the PaymentCurrency is not the same as the InvoiceCurrency.TaxAccountingSubTotalValue holds the equivalent value to the line item TotalValue in the TaxAccountingCurrency.ActualPaymentStatus contains information relating to the payment status of the line item.TotalTaxAmount holds the total amount of tax for the line item.Content: BillToParty (Type: Party)? , RemitToParty (Type: Party)? , ListOfPartyCoded?
Description: The OtherInvoiceParties element contains information on other parties for the line item, including unique ID's and address information.
BillToParty holds information relating to the BillToParty.RemitToParty holds information relating to the RemitToParty.ListOfPartyCoded contains information on the role of a party.Content: InvoiceMediumCoded (Type: InvoiceMediumCode)? , InvoiceMediumCodedOther (Type: string)?
Description: The InvoiceMedium element is the method of communicating the invoice.
InvoiceMediumCoded is a code specifying the communication medium used for the invoice.InvoiceMediumCodedOther is used to provide a non-standard InvoiceMediumCode. This element is mandatory if the value of InvoiceMediumCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Value: Enumeration, including:
Content: BuyerParty (Type: Party) , BuyerTaxInformation (Type: PartyTaxInformation)? , BuyerTax (Type: Tax)? , SellerParty (Type: Party) , SellerTaxInformation (Type: PartyTaxInformation)? , ShipToParty (Type: Party)? , BillToParty (Type: Party)? , RemitToParty (Type: Party)? , RemitToTaxInformation (Type: PartyTaxInformation)? , RemitToTax (Type: Tax)? , ShipFromParty (Type: Party)? , WarehouseParty (Type: Party)? , SoldToParty (Type: Party)? , ManufacturingParty (Type: Party)? , MaterialIssuerParty (Type: Party)? , ListOfPartyCoded?
Description: The InvoiceParty element contains information on the parties to the Invoice, including unique ID's and address information.
BuyerParty contains party information for the party buying the goods.BuyerTaxInformation describes the taxing information for the party buying the goods.BuyerTax identifies the tax levy information for the party buying the goods.SellerParty contains party information for the party selling the goods.SellerTaxInformation describes the taxing information for the party selling the goods.ShipToParty contains party information for the party to which the items on the invoice are to be or have been shipped.BillToParty holds information relating to the party who will receive the bill for the goods.RemitToParty holds information relating to the party that is to be paid.RemitToTaxInformation describes the taxing information for the party that is to be paid.RemitToTax identifies the tax levy information for the party that is to be paid.ShipFromParty contains party information identifying the location from which the items are to be shipped.WarehouseParty contains party information identifying the warehouse from which the items are to be shipped.SoldToParty contains party information identifying the location where the items were sold.ManufacturingParty contains party information identifying the location where the item is to be manufactured.MaterialIssuerParty contains party information identifying the location that is issuing the request for the material.ListOfPartyCoded contains all other parties for the Invoice not explicitly stated as the content of other elements.Content: InvoicePurposeCoded (Type: InvoicePurposeCode) , InvoicePurposeCodedOther (Type: string)?
Description: The InvoicePurpose element defines the purpose of the invoice.
InvoicePurposeCoded is a code specifying the purpose of the invoice. This is a subset of PurposeCode.InvoicePurposeCodedOther is used to provide a non-standard InvoicePurposeCode. This element is mandatory if the value of InvoicePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the purpose of the Invoice message. This is a subset code list derived from EDIFACT 1225 (Message Function, Coded) and X12 353 (Transaction Set Purpose Code) and 587 (Acknowledgement Type Code)
Value: Enumeration, including:
Content: PurchaseOrderReference? , ContractReference (Type: Contract)? , AccountNumber (Type: Reference)? , ProformaInvoiceNumber (Type: Reference)? , ASNNumber (Type: Reference)? , ASNOrderNumber? , SupplierOrderNumber (Type: Reference)? , PriceListNumber (Type: Reference)? , PriceListVersionNumber (Type: Reference)? , BuyersCatalogNumber (Type: Reference)? , BillOfLadingNumber (Type: Reference)? , AirWayBillNumber (Type: Reference)? , LetterOfCreditNumber (Type: Reference)? , AuthorizationReference? , DeliveryNoteNumber (Type: Reference)? , CostAllocation? , ListOfRelatedInvoiceRef? , OtherInvoiceReferences (Type: ListOfReferenceCoded)?
Description: The InvoiceReferences element contains external references to the Invoice that are important to the processing and use of the Invoice.
PurchaseOrderReference contains information relevant to the purchase order the invoice is issued against.ContractReference contains the contract number which the purchase order is referencing.AccountNumber holds the buyers account code with the supplier.ProformaInvoiceNumber holds the reference number for the proforma invoice.ASNNumber holds the ASN or despatch advice number.ASNOrderNumber contains the references for the ASN or despatch advice order number and line item information.SupplierOrderNumber contains the references for the supplier order number information.PriceListNumber holds the reference number of the price list.PriceListVersionNumber holds the version number of the price list.BuyersCatalogNumber holds the catalog number of the buyer.BillOfLadingNumber holds the bill of lading number for the invoice.AirWayBillNumber holds the air waybill number of the invoice.LetterOfCreditNumber holds the number of the letter of credit for the invoice.AuthorizationReference contains information for the authorization for the purchase order.DeliveryNoteNumber contains the references for the delivery note.CostAllocation contains information on the cost allocation.ListOfRelatedInvoiceRef contains a list of other invoices related to this invoice or InvoiceDetail.OtherInvoiceReferences contains all other references for the Invoice not explicitly stated as the content of other elements.Content: AuthorizationNumber (Type: Reference) , AuthorizationAssignedBy (Type: Party)?
Description: The AuthorizationReference element contains information for the authorization for the purchase order.
AuthorizationNumber holds the authorization number used when a third party needs to authorize the validity of a purchase order.AuthorizationAssignedBy contains information relating to the party issuing the authorization number.Content: CostAllocationNumber (Type: Reference) , WorkBreakdownStructure (Type: string)? , FixedAsset (Type: string)?
Description: The CostAllocation element contains information on the cost allocation.
CostAllocationNumber holds the cost allocation number that the invoice will be charged against.WorkBreakdownStructure holds information relating to the work breakdown.FixedAsset is used to identify if the invoice is for a fixed asset or a consumable.Content: NumberOfLines (Type: int)? , InvoiceTotals? , ListOfTaxSummary? , AllowOrChargeSummary? , InvoicePaymentStatus? , ListOfActualPayment? , SummaryNote (Type: string)?
Description: The InvoiceSummary element contains summary information relating to the Invoice.
NumberOfLines contains the number of line items in the Invoice.InvoiceTotals contains a number of totals relevant to the Invoice.ListOfTaxSummary contains the summary of the tax information specified within the Invoice. This element is mandatory if tax elements occur in either the invoice header or any invoice detail item line.AllowOrChargeSummary contains the summary amounts, for each category of the allowance or charge.InvoicePaymentStatus contains information relating to the payment status of the invoice.ListOfActualPayment contains a list of information relating to payment(s) made on the invoice at the time the invoice was produced.SummaryNote contains any free form text pertinent to the invoice summary. 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: TotalAllowOrCharge+
Description: The AllowOrChargeSummary element contains the summary amounts, for each category of the allowance or charge.
TotalAllowOrCharge contain the details of the summerized totals of the allowance or charge categorized by the AllowOrChargeDesc.Content: AllowOrChargeIndicatorCoded (Type: AllowOrChargeIndicatorCode) , AllowOrChargeIndicatorCodedOther (Type: string)? , AllowanceOrChargeDescription (Type: AllowOrChgDesc) , SummaryAllowOrCharge (Type: MonetaryValue)
Description: The TotalAllowOrCharge element contain the details of the summerized totals of the allowance or charge categorized by the AllowOrChargeDesc.
AllowOrChargeIndicatorCoded identifies whether the allowance or charge applies.AllowOrChargeIndicatorCodedOther is used to provide a non-standard AllowanceOrChargeIndicatorCode. This element is mandatory if the value of AllowanceOrChargeIndicatorCoded is 'Other'. These codes should not contain white space unless absolutely necessary.AllowanceOrChargeDescription describes the allowance or charge using references or free text.SummaryAllowOrCharge contains the summerized totals of the allowance or charge.Description:
This code indicates an allowance or charge for the specified service. This codelist is derived from EDIFACT 5463 (Allowance) and X12 248 (Allowance Or Charge Indicator)
Value: Enumeration, including:
Content: InvoicePaymentStatusCoded (Type: ActualPaymentStatusCode)? , InvoicePaymentStatusCodedOther (Type: string)?
Description: The InvoicePaymentStatus element contains information relating to the payment status of the invoice.
InvoicePaymentStatusCoded is a code specifying the status of the invoice payment.InvoicePaymentStatusCodedOther is used to provide a non-standard ActualPaymentStatusCode. This element is mandatory if the value of InvoicePaymentStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: NetValue (Type: MonetaryValue) , GrossValue (Type: MonetaryValue) , TaxValue (Type: MonetaryValue)? , TaxValueInTaxAccountingCurrency (Type: MonetaryValue)? , ChargeTotal (Type: MonetaryValue)? , TotalAmountPayable (Type: MonetaryValue)? , PrepaidAmount (Type: MonetaryValue)? , TotalDiscount (Type: MonetaryValue)? , TotalTaxAmount (Type: MonetaryValue)? , TotalAmountMinusDiscount (Type: MonetaryValue)?
Description: The InvoiceTotals element contains a number of totals relevant to the Invoice.
NetValue holds the net value of the invoice in the invoice currency.GrossValue holds the gross value of the invoice in the invoice currency.TaxValue holds the total taxable value for the invoice in the invoice currency.TaxValueInTaxAccountingCurrency holds the TaxValue in the tax accounting currency.ChargeTotal holds the total of the invoice summary-level charge information.TotalAmountPayable holds the total amount to be paid.PrepaidAmount holds the total amount prepaid.TotalDiscount holds the total discount amount applicable to the invoice.TotalTaxAmount holds the total amount of tax on the invoice.TotalAmountMinusDiscount holds the total amount after discount as specified in the PaymentInstructions and line item allowances.Content: InvoiceTypeCoded (Type: InvoiceTypeCode) , InvoiceTypeCodedOther (Type: string)?
Description: The InvoiceType element identifies the type of the invoice being transmitted.
InvoiceTypeCoded is a code specifying the type of the invoice.InvoiceTypeCodedOther is used to provide a non-standard InvoiceTypeCode. This element is mandatory if the value of InvoiceTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of the Invoice message.
Value: Enumeration, including:
Content: InvoicingDetailReference (Type: ReferenceCoded) , InvoicingDetailAmountDue (Type: MonetaryValue)? , InvoicingDetailAmountPaid (Type: MonetaryValue)? , InvoicingItemDetail (Type: InvoiceItemDetail)? , ListOfAdjustments?
Description: The InvoicingDetail element contains information relating to the payment document for which the RemittanceAdvice is placed against.
InvoicingDetailReference contains a unique reference number for the invoicing document. (i.e. Invoice Number, Purchase Order Number). This structure contains a coded reference field along with a line item number.InvoicingDetailAmountDue contains the total amount due for the line item as stated on the payment document.InvoicingDetailAmountPaid contains the total amount that is being paid for the line item of the associated payment document.InvoicingItemDetail contains line item detail relating to the payment document. This structure is an extension of the InvoiceItemDetail data structure.ListOfAdjustments contains line item adjustment detail.Content: InvoicingDetail+
Description: The ListOfInvoicingDetail element contains a set of invoicing detail.
InvoicingDetail contains information relating to the payment document for which the RemittanceAdvice is placed against.Description:
This code identifies the characteristic of an item. This code list is derived from EDIFACT 7081 (Item characteristic code) and X12 750 (Product/process characteristic code)
Value: Enumeration, including:
Content: BaseItemDetail , PricingDetail? , DeliveryDetail? , LineItemNote (Type: string)? , ListOfStructuredNote? , LineItemAttachments (Type: ListOfAttachment)?
Description: The ItemDetail element contains information to describe and identify an item along with all pricing and delivery information for that item.
BaseItemDetail identifies the line item for the document. This contains the description, specific identifiers, weights, measures and other information associated with the product.PricingDetail contains all pricing information, including taxes, allowances and charges, and total price for an item.DeliveryDetail 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.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.LineItemAttachments contains attachments for the line item.Content: ItemDetail+
Description: The ListOfItemDetail element holds one or more items for the document.
ItemDetail contains the item detail information.Content: PackageReference+
Description: The ItemPackagingReference element contains reference information when detailed packaging information contained in list of package detail is to be associated with the line item.
PackageReference provides a reference for the packaging of the item.Content: Quantity? , PackageIDReference (Type: int) , PackageReference?
Description: The PackageReference element provides a reference for the packaging of the item.
Quantity is the quantity of the item in the referenced package.PackageIDReference references the package ID of the package containing the item found in the PackageDetail element.PackageReference provides a reference for the packaging of the item.Description:
This code identifies the status of the part being ordered or forecast with respect to the material release or planning document. This code list is derived from X12 682 (Part release status code)
Value: Enumeration, including:
Content: ResourceAuthorizationCoded (Type: ResourceAuthorizationCode) , ResourceAuthorizationCodedOther (Type: string)? , ValidityDates?
Description: The ItemResourceAuthorization element is used to specify resource authorization in the schedule.
ResourceAuthorizationCoded is the code identifying the resource authorization for the schedule quantity. The quantity fields are cumulative when this segment is used.ResourceAuthorizationCodedOther is used to provide a non-standard ResourceAuthorizationCode. This element is mandatory if the value of ResourceAuthorizationCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ValidityDates contains the dates between which the allowance or charge takes effect.Description:
This code identifies the resource authorization for the schedule quantity. This code list is derived from X12 672 (Resource authorization code)
Value: Enumeration, including:
Content: KeyFigureID (Type: string) , KeyFigureName (Type: string)? , KeyFigureDescription (Type: string)?
Description: The KeyFigure element is the key figure data used to identify the name, type, and value of a key figure used in a time series.
KeyFigureID is the key that uniquely identifies a key figure via its technical name with respect to the TimeSeriesSystemType given at the header. Eg: APO_FORECAST.KeyFigureName contains the predefined name used for the key figure. Eg: sales forecast.KeyFigureDescription contains the alternate name used to rename the given key figure. Eg: my sales forecast.Content: SourceKeyFigure (Type: KeyFigure)? , TargetKeyFigure (Type: KeyFigure)?
Description: The KeyFigureInformation element is used to identify the name, type, and value of a key figure used in a time series with respect to the source or target systems.
SourceKeyFigure is the key figure data with respect to the source system.TargetKeyFigure is the key figure data with respect to the target system.Content: KeyFigurePurposeCoded (Type: TimeSeriesPurposeCode)? , KeyFigurePurposeCodedOther (Type: string)? , CharacteristicCombinationID (Type: string)? , KeyFigureInformation , UnitOfMeasurement , KeyFigureNotes (Type: string)?
Description: The KeyFigureData element defines the key figure and includes all of the time series data values.
KeyFigurePurposeCoded is the detail level response code to indicate whether there was an error in the key figure or time series data. This code is sent in response to a TimeSeriesRequest.KeyFigurePurposeCodedOther is used to provide a non-standard KeyFigurePurposeCode. This element is mandatory if the value of KeyFigurePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.CharacteristicCombinationID is the key to uniquely identify the characteristic combination. The CharacteristicCombinationID for the TimeSeriesRequest document is optional.KeyFigureInformation is used to identify the name, type, and value of a key figure used in a time series with respect to the source or target systems.UnitOfMeasurement specifies the unit of measure of rate.KeyFigureNotes is used to provide additional key figure information.Content: KeyFigureData+
Description: The ListOfKeyFigureData element contains a list of all the key figure and time series data related information.
KeyFigureData defines the key figure and includes all of the time series data values.Content: KeyValString (Type: string) , Language , Keyword (Type: string)
Description: The KeyVal element is used to associate a value with a custom qualifier.
KeyValString is used to hold a value that is to be qualified by the Keyword.Language identifies the language that the KeyValString is written in.Keyword is used to qualify the KeyValString.Content: KeyVal+
Description: The ListOfKeyVal element contains one or more KeyVal elements.
KeyVal is used to associate a value with a custom qualifier.Content: LanguageCoded (Type: LanguageCode) , LanguageCodedOther (Type: string)? , LocaleCoded (Type: LocaleCode)? , LocaleCodedOther (Type: string)?
Attribute: Name: LanguageDependent - Data Type: boolean - Default Value: #IMPLIEDDescription: The Language element is used to provide information about the language which text is written in.
LanguageCoded identifies the language using ISO standards.LanguageCodedOther is used to provide a non-standard LanguageCode. This element is mandatory if the value of LanguageCoded is 'Other'. These codes should not contain white space unless absolutely necessary.LocaleCoded identifies the locale/location where the language is spoken.LocaleCodedOther is used to provide a non-standard LocaleCode. This element is mandatory if the value of LocaleCoded is 'Other'. These codes should not contain white space unless absolutely necessary.LanguageDependent defines whether a document is language dependent or not.Content: Language+
Description: The ListOfLanguage element contains a list of languages.
Language is used to provide information about the language which text is written in.Content: LangString (Type: string) , Language
Description: The LanguageString element is a string with an optional language specification. If the language is not provided, it is assumed that the language is known from the context in which the LanguageString is used.
LangString is the free form text field.Language identifies the language that the text is written in.Content: LanguageString+
Description: The ListOfLanguageString element contains one or more LanguageString elements.
LanguageString is a string with an optional language specification. If the language is not provided, it is assumed that the language is known from the context in which the LanguageString is used.Description:
This code identifies the language being used. This code list is derived from ISO 639-1998
Value: Enumeration, including:
Content: LegalReportingIndicator (Type: string) , LegalReportingSupplementalCode (Type: string)? , LegalReportingParty (Type: Company)? , LegalReportingInvoicedAmount (Type: MonetaryValue) , LegalReportingPaymentAmount (Type: MonetaryValue)? , LegalReportingSupplyingCountry (Type: Country)? , LegalReportingPayeeCountry (Type: Country)? , LegalReportingImportDate (Type: datetime)? , LegalReportingPaymentDate (Type: datetime)?
Description: The LegalReportingInformation element contains legal reporting information associated with payments made to a foreign payee. This is used by central banks for processing cross border payments over a certain amount.
Countries where used: Austria, Belgium, Germany, Denmark, Finland, Japan, Netherlands, Norway, Sweden
LegalReportingIndicator contains a country specific code assigned by the central bank.LegalReportingSupplementalCode contains an additional code that is country dependent used for further identification.LegalReportingParty identifies the company responsible for legal reporting.LegalReportingInvoicedAmount contains the total invoiced amount.LegalReportingPaymentAmount contains the total amount of payment.LegalReportingSupplyingCountry specifies the country where the services or goods originate.LegalReportingPayeeCountry specifies the country in from which the payment is made.LegalReportingImportDate specifies the import date that is legally reported.LegalReportingPaymentDate specifies the payment date that is legally reported.Content: FIAccountData+
Description: The ListOfFIAccount element contains information pertinent to identifying a financial institution and an account within the financial institution.
FIAccountData extends the definition of FIAccount, which identifies an account at a financial institution.Note: The financial institution information will be required but the Account information will be optional in this structure.
Extends: FIAccount
Description: The FIAccountData element extends the definition of FIAccount, which identifies an account at a financial institution, with the following information: Sequence, FINote. Note: The financial institution information will be required but the Account information will be optional in this structure.
Sequence contains a counter used for specifying an intermediary bank's position for a given financial transaction with respect to the originating and receiving bank.FINote describes any free-form text that can be used to specify additional information about the financial institution.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: MVBVariable+
Description: The ListOfMVBVariables element 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.
MVBVariable contains the originator required variable values only. These are customer defined variables that do not currently exist in the AuctionCreate document.Content: MVBVariableName (Type: string) , (MVBVariableValue (Type: string) | MVBRange (Type: Range))
Description: The MVBVariable element contains the originator required variable values only. These are customer defined variables that do not currently exist in the AuctionCreate document.
MVBVariableName contains the name of the MVB variable. This name must match the variable name defined within the MVB template which is previously determined by the originator of the auction.MVBVariableValue contains the value of the MVB variable. There is currently no restriction on the valid contents of the variable value.If a date is given, then the value needs to be in the format: DDMMYYYY
MVBRange contains a range of values. This is a numeric or date value.if date range is given, then the value needs to be in the format: DDMMYYYY
Content: OrderStatusItem+
Description: The ListOfOrderStatusItem element is a container holding the line item information.
OrderStatusItem contains item detail information for the OrderStatusRequest.Extends: BaseItemDetail
Description: The OrderStatusItem element contains item detail information for the OrderStatusRequest.
OrderStatusItemTransport contains the transport information for the line item.VarianceQty describes the difference between the invoiced quantity and the quantity that was ordered.Content: OrderStatusResultItem+
Description: The ListOfOrderStatusResultItem element contains a list of line items for the OrderStatusResult.
OrderStatusResultItem contains the identifying and descriptive information for the line items in OrderStatusResult.Extends: BaseItemDetail
Description: The OrderStatusResultItem element contains the identifying and descriptive information for the line items in OrderStatusResult.
OrderStatusItemResultTransport contains the transport information for the line item.VarianceQty describes the difference between the invoiced quantity and the quantity that was ordered.ItemStatus provides information about the status of the line item.Content: ItemStatusQuantity (Type: Quantity) , ItemStatusEvent (Type: Status) , PaymentStatusEvent (Type: Status)? , ShipmentStatusEvent?
Description: The ItemStatus element provides a status for the item.
ItemStatusQuantity gives a quantity (less than the total item quantity) for which this combination of status events are applicable.ItemStatusEvent provides a general item status.PaymentStatusEvent provides a payment status.ShipmentStatusEvent provides a shipment status.Extends: Status
Description: The ShipmentStatusEvent element provides a status related to the ship date of the item(s).
ShipDate holds the ship date relative to the reported status.Content: TradingPartnerID (Type: Identifier)+
Description: The ListOfTradingPartnerID element is a container holding one or more trading partner identifiers.
TradingPartnerID is a unique identifier for the trading partner.Description:
This code identifies the location where the language is spoken.
Value: Enumeration, including:
Content: LocationQualifierCoded (Type: LocationQualifierCode)? , LocationQualifierCodedOther (Type: string)? , (LocationIdentifier | ExternalAddressID (Type: string) | NameAddress) , GPSCooridinates?
Description: The Location element identifies a place by its function and either an identifier, an identification assigned to an address, or an address.
LocationQualifierCoded provides the function of the location using a standard codelist.LocationQualifierCodedOther is used to provide a non-standard LocationQualifierCode. This element is mandatory if the value of LocationQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.LocationIdentifier contains the location identifier and the agency responsible for issuing the identifier.ExternalAddressID contains the information to identify the address.NameAddress identifies the location as a specific name and/or address.GPSCooridinates identifies the location by specific co-ordinates.Content: GPSSystem (Type: string) , Latitude (Type: string) , Longitude (Type: string)
Description: The GPSCooridinates element identifies the location by specific co-ordinates.
GPSSystem identifies the GPS system.Latitude specifies the latitude of the location.Longitude specifies the longitude of the location.Content: LocID (Type: Identifier) , LocationDescription (Type: string)?
Description: The LocationIdentifier element contains the location identifier and the agency responsible for issuing the identifier.
LocID specifies the location using an identifier such as a UNLOC code, EAN code or other similar code system.LocationDescription describes the location such as a city in a free text format.Content: Location+
Description: The ListOfLocation element contains a list of locations.
Location identifies a place by its function and either an identifier, an identification assigned to an address, or an address.Content: Location , ListOfContact? , ListOfLocationPlanningItemDetail
Description: The LocationGroupedPlanningDetail element contains all the schedule-line-level data grouped by the delivery location.
Location contains details relevant to describing the location. This includes name, address, and contact information. Note: each delivery point can have multiple materials planned for the location. In addition, each material at each location can contain multiple scheduled delivery dates and quantities.ListOfContact lists the information on one or more contacts by the parties involved.ListOfLocationPlanningItemDetail is a list of item details organized by location.Content: LocationGroupedPlanningDetail+
Description: The ListOfLocationGroupedPlanningDetail element contains the line level detail information for the PlanningSchedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the PlanningSchedule.
LocationGroupedPlanningDetail contains all the schedule-line-level data grouped by the delivery location.Content: DetailResponseCoded (Type: DetailResponseCode) , DetailResponseCodedOther (Type: string)? , OriginalLocationGroupedPlanningDetail (Type: LocationGroupedPlanningDetail)? , ChangedLocationGroupedPlanningDetail (Type: LocationGroupedPlanningDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The LocationGroupedPlanningResponse element contains all the schedule-line-level data grouped by the delivery location.
DetailResponseCoded is a code to identify the response for the line item detail.DetailResponseCodedOther is used to provide a non-standard DetailResponseCode. This element is mandatory if the value of DetailResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginalLocationGroupedPlanningDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ChangedLocationGroupedPlanningDetail 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 described by the PlanningScheduleResponse. 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 is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.Content: LocationGroupedPlanningResponse+
Description: The ListOfLocationGroupedPlanningResponse element contains the line level detail information for the planning schedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the PlanningScheduleResponse document.
LocationGroupedPlanningResponse contains all the schedule-line-level data grouped by the delivery location.Content: Location , ListOfContact? , ListOfLocationShippingItemDetail
Description: The LocationGroupedShippingDetail element contains all the schedule-line-level data grouped by the delivery location.
Location contains details relevant to describing the location. This includes name, address, and contact information.ListOfContact lists the information on one or more contacts by the parties involved.ListOfLocationShippingItemDetail is a list of item details organized by location.Content: LocationGroupedShippingDetail+
Description: The ListOfLocationGroupedShippingDetail element contains the line level detail information for the ShippingSchedule document. The detail is grouped by the delivery point. This is one of two options for grouping the shipping detail.
LocationGroupedShippingDetail contains all the schedule-line-level data grouped by the delivery location.Content: DetailResponseCoded (Type: DetailResponseCode) , DetailResponseCodedOther (Type: string)? , OriginalLocationGroupedShippingDetail (Type: LocationGroupedShippingDetail)? , ChangedLocationGroupedShippingDetail (Type: LocationGroupedShippingDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The LocationGroupedShippingResponse element contains all the schedule-line-level data grouped by the delivery location.
DetailResponseCoded is a code to identify the response for the line item detail.DetailResponseCodedOther is used to provide a non-standard DetailResponseCode. This element is mandatory if the value of DetailResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginalLocationGroupedShippingDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ChangedLocationGroupedShippingDetail identifies the line to be added/deleted or to identify the changes to an existing line item.LineItemNote is a note containing general information for the ShippingScheduleResponse line item.ListOfStructuredNote is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.Content: LocationGroupedShippingResponse+
Description: The ListOfLocationGroupedShippingResponse element contains the line level detail information for the planningschedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the ShippingScheduleResponse.
LocationGroupedShippingResponse contains all the schedule-line-level data grouped by the delivery location.Content: BasePlanningDetail , ListOfScheduleDetail , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The LocationPlanningItemDetail element is a collection of items that are grouped by location for planning purposes.
BasePlanningDetail extends BaseItemDetail to include item schedule reference, release frequency and item quantities.ListOfScheduleDetail is the detailed schedule information for the materials. Includes dates and quantity.LineItemNote describes any free-form text pertinent to the line item described by the PlanningSchedule. 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 is a structured note which contains an identifier and URL.Content: LocationPlanningItemDetail+
Description: The ListOfLocationPlanningItemDetail element is a list of item details organized by location.
LocationPlanningItemDetail is a collection of items that are grouped by location for planning purposes.Description:
This code identifies the type of the location. This code list is derived from X12 309 (Location Qualifier)
Value: Enumeration, including:
Content: Location? , ListOfContact? , ListOfScheduleDetail
Description: The LocationSchedule element is a schedule for the material based on location.
Location contains details relevant to describing the location. This includes name, address, and contact information.ListOfContact lists the information on one or more contacts by the parties involved.ListOfScheduleDetail is the detailed schedule information for the materials. Includes dates and quantity.Content: LocationSchedule+
Description: The ListOfLocationSchedule element is the scheduling information by location for the material identified by the line item.
LocationSchedule is a schedule for the material based on location.Content: Location? , ListOfContact? , ListOfShipScheduleDetail
Description: The LocationShipSchedule element is a schedule for the material based on location.
Location contains details relevant to describing the location. This includes name, address, and contact information.ListOfContact lists the information on one or more contacts by the parties involved.ListOfShipScheduleDetail is the detailed schedule information for the materials. Includes dates and quantity.Content: LocationShipSchedule+
Description: The ListOfLocationShipSchedule element is the scheduling information by location for the material identified by the line item.
LocationShipSchedule is a schedule for the material based on location.Content: BaseShippingDetail , ListOfShipScheduleDetail , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The LocationShippingItemDetail element is a collection of items that are grouped by location for shipping purposes.
BaseShippingDetail extends BaseItemDetail to include item schedule reference, release frequency and item quantities.ListOfShipScheduleDetail is the detailed schedule information for the materials. Includes dates and quantity.LineItemNote contains any free-form text pertinent to the entire ShippingSchedule. 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 is a structured note which contains an identifier and URL.Content: LocationShippingItemDetail+
Description: The ListOfLocationShippingItemDetail element is a list of item details organized by location.
LocationShippingItemDetail is a collection of items that are grouped by location for shipping purposes.Description: The LongDescription element provides a long textual 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.".
lang language for the text description.DescriptionPurpose is an attribute that attempts to describe what the description is for. Examples of valid values are "sales" and "internal use only".Content: BasePlanningDetail , ListOfLocationSchedule , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The MaterialGroupedPlanningDetail element contains all the schedule-line-level data grouped by the material/product.
BasePlanningDetail extends BaseItemDetail to include item schedule reference, release frequency and item quantities.ListOfLocationSchedule is the scheduling information by location for the material identified by the line item.LineItemNote describes any free-form text pertinent to the line item described by the PlanningSchedule. 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 is a structured note which contains an identifier and URL.Content: MaterialGroupedPlanningDetail+
Description: The ListOfMaterialGroupedPlanningDetail element contains the line level detail information for the PlanningSchedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the PlanningSchedule.
MaterialGroupedPlanningDetail contains all the schedule-line-level data grouped by the material/product.Content: DetailResponseCoded (Type: DetailResponseCode) , DetailResponseCodedOther (Type: string)? , OriginalMaterialGroupedPlanningDetail (Type: MaterialGroupedPlanningDetail)? , ChangedMaterialGroupedPlanningDetail (Type: MaterialGroupedPlanningDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The MaterialGroupedPlanningResponse element contains all the schedule-line-level data grouped by the material/product for the PlanningSchedule and the PlanningScheduleResponse document.
DetailResponseCoded is a code to identify the response for the line item detail.DetailResponseCodedOther is used to provide a non-standard DetailResponseCode. This element is mandatory if the value of DetailResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginalMaterialGroupedPlanningDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ChangedMaterialGroupedPlanningDetail 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 described by the PlanningScheduleResponse. 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 is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.Content: MaterialGroupedPlanningResponse+
Description: The ListOfMaterialGroupedPlanningResponse element contains the line level detail information for the planning schedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the PlanningScheduleResponse document.
MaterialGroupedPlanningResponse contains all the schedule-line-level data grouped by the material/product for the PlanningSchedule and the PlanningScheduleResponse document.Content: BaseShippingDetail , ListOfLocationShipSchedule , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The MaterialGroupedShippingDetail element contains all the schedule-line-level data grouped by the material/product.
BaseShippingDetail is the base item detail for the ShippingSchedule. It extends BaseItemDetail to include release frequency and packaging information.ListOfLocationShipSchedule is the scheduling information by location for the material identified by the line item.LineItemNote contains any free-form text pertinent to the entire ShippingSchedule. 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 is a structured note which contains an identifier and URL.Content: MaterialGroupedShippingDetail+
Description: The ListOfMaterialGroupedShippingDetail element contains the line level detail information for the ShippingSchedule document. The detail is grouped by the material. This is one of two options for grouping shipping detail.
MaterialGroupedShippingDetail contains all the schedule-line-level data grouped by the material/product.Content: DetailResponseCoded (Type: DetailResponseCode) , DetailResponseCodedOther (Type: string)? , OriginalMaterialGroupedShippingDetail (Type: MaterialGroupedShippingDetail)? , ChangedMaterialGroupedShippingDetail (Type: MaterialGroupedShippingDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The MaterialGroupedShippingResponse element contains all the schedule-line-level data grouped by the material/product for the ShippingSchedule and the ShippingScheduleResponse document.
DetailResponseCoded is a code to identify the response for the line item detail.DetailResponseCodedOther is used to provide a non-standard DetailResponseCode. This element is mandatory if the value of DetailResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginalMaterialGroupedShippingDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ChangedMaterialGroupedShippingDetail identifies the line to be added/deleted or to identify the changes to an existing line item.LineItemNote is a note containing general information for the ShippingScheduleResponse line item.ListOfStructuredNote is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.Content: MaterialGroupedShippingResponse+
Description: The ListOfMaterialGroupedShippingResponse element contains the line level detail information for the planning schedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the ShippingScheduleResponse document.
MaterialGroupedShippingResponse contains all the schedule-line-level data grouped by the material/product for the ShippingSchedule and the ShippingScheduleResponse document.Content: (MeasurementValue | MeasurementRange) , UnitOfMeasurement
Description: The Measurement element is the quantitative value expressed as either a value or a range and unit of measure.
MeasurementValue contains the value of the measurement.MeasurementRange defines the minimum and maximum value of a measurement.UnitOfMeasurement contains the unit of measure for the measurement.Content: number
Attribute: Name: SignificanceCoded - Data Type: SignificanceCode - Default Value: #IMPLIEDDescription: The MeasurementValue element contains the value of the measurement.
SignificanceCoded describes the significance of the a quantity using a standard codelist.SignificanceCodedOther is used to provide a non-standard SignificanceCode. This element is mandatory if the value of SignificanceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ConditionsCoded describes the conditions that apply to the quantity.ConditionsCodedOther is used to provide a non-standard ConditionsCode. This element is mandatory if the value of ConditionsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: MinimumValue , MaximumValue
Description: The MeasurementRange element defines a range which a measurement may fall in by a minimum and maximum value.
MinimumValue specifies the minimum value of the range.MaximumValue specifies the maximum value of the range.Content: Measurement+
Description: The ListOfMeasurement element lists one or more measurements.
Measurement is the quantitative value expressed as either a value or a range and unit of measure.Content: AcknowledgementLocation (Type: string)? , AcknowledgementReferenceNumber (Type: string)? , AcknowledgementNote (Type: string)?
Description: The MessageAcknowledgement element is part of a larger business process defined by a document exchange. Message acknowledgements are used by e-business parties to notify the sender of a message/document that the message has been received. Message acknowledgements are not used to indicate a syntactical or content check of the received document.
AcknowledgementLocation references the location in the system in which the corresponding message is being acknowledged. For example, "MyCompany.XPC.MsgAckResponder" and "MyCompany.Translator".AcknowledgementReferenceNumber is a reference number that can be used to associate the message acknowledgement with an originating message.AcknowledgementNote is a note than can included with the message acknowledgement.Content: IDNumber (Type: string) , IDAssignedBy , IDAssignedDate (Type: datetime)?
Description: The MessageID element contains the identification for a message.
IDNumber contains the identifier for the message.IDAssignedBy identifies who assigns the MessageID to the message.IDAssignedDate contains the date the ID was assigned.Content: IDAssignedByCoded (Type: PartyRoleCode) , IDAssignedByCodedOther (Type: string)?
Description: The IDAssignedBy element identifies who assigns the MessageID to the message.
IDAssignedByCoded identifies the role of the party that assigned the ID.IDAssignedByCodedOther is used to provide a non-standard IDAssignedByCode. This element is mandatory if the value of IDAssignedByCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: MessageID+
Description: The ListOfMessageID element contains one or more identifiers for a message.
MessageID contains the identification for a message.Description:
This code identifies the method of handling for an allowance or charge. This code list is derived from X12 331 (Allowance or charge method of handling code)
Value: Enumeration, including:
Content: MinimumMonetaryValue (Type: Decimal21_6) , MaximumMonetaryValue (Type: Decimal21_6) , Currency
Description: The MonetaryRange element identifies a range of monetary values.
MinimumMonetaryValue specifies the minimum monetary value in the range.MaximumMonetaryValue specifies the maximum monetary value in the range.Currency is a container for the currency code.Content: MonetaryRange | MonetaryLimit
Description: The BasisMonetaryRange element is the monetary range over which the allowance or charge applies.
MonetaryRange identifies a monetary range from which the allowance or charge will apply.MonetaryLimit is used to specify either a lower or upper bound, beyond which an allowance or charge will apply.Content: MonetaryLimitValue (Type: Decimal21_6) , Currency
Attribute: Name: SignificanceCoded - Data Type: SignificanceCode - Default Value: #IMPLIEDDescription: The MonetaryLimit element is used to specify either a lower or upper bound, beyond which an allowance or charge will apply.
MonetaryLimitValue is a number representing the monetary limit.Currency specifies the currency that MonetaryLimitValue is expressed.SignificanceCoded is used to specify whether the MonetaryLimitValue is a lower or upper limit.SignificanceCodedOther is used to provide a non-standard SignificanceCode. This element is mandatory if the value of SignificanceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: MonetaryAmount (Type: Decimal21_6) , Currency? , RateOfExchangeDetail?
Description: The MonetaryValue element is used to specify an amount of money and the currency.
MonetaryAmount contains the value of the monetary amount.Currency specifies the currency that the MonetaryValue is expressed in.RateOfExchangeDetail can be used if the exchange rate to another currency needs to be set for the monetary value expressed.Content: ExternalAddressID (Type: string)? , Name1 (Type: string) , Name2 (Type: string)? , Name3 (Type: string)? , Identifier? , POBox? , Street (Type: string)? , HouseNumber (Type: string)? , StreetSupplement1 (Type: string)? , StreetSupplement2 (Type: string)? , Building (Type: string)? , Floor (Type: string)? , RoomNumber (Type: string)? , InhouseMail (Type: string)? , Department (Type: string)? , PostalCode (Type: string)? , City (Type: string)? , County (Type: string)? , Region? , District (Type: string)? , Country? , Timezone?
Attribute: Name: AddressTypeCoded - Data Type: AddressTypeCode - Default Value: "NotApplicable"Description: The NameAddress element contains the name and the address information for an entity.
ExternalAddressID contains a GUID that is used for referencing the address when specifying specific user information (unique within partner organization).Name1 contains the name of an entity.Name2 contains additional name information.Name3 contains further additional name information.Identifier contains a specific identifier for the name.POBox contains a post office box number.Street contains the name of the street.HouseNumber contains the house number.StreetSupplement1 contains any additional information to identify the street.StreetSupplement2 contains any further additional information to identify the street.Building contains the name of the building.Floor contains the number of the floor.RoomNumber contains the room identifier.InhouseMail contains the inhouse mail identifier.Department contains the department number or name.PostalCode contains the identifier for one or more properties according to the postal service of that country (Zip-Code in US).City contains the name of the city.County contains the name of the county.Region contains the name of the region within a country specific to this address. Used to hold the state in US addresses.District contains the name of the district.Country identifies the country.Timezone identifies the time zone that the location operates to.AddressTypeCoded specifies the category of the address using a standard code list.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: The POBox element contains the post office box number. This is a string content model.
POBoxPostalCode is used to hold the postal code associated with the post office box.Content: NameAddress+
Description: The ListOfNameAddress element contains one or more addresses for an entity.
NameAddress contains the name and the address information for an entity.Content: Name (Type: string) , Value (Type: string)
Description: The NameValuePair element contains a generic name and value.
Name contains the generic name.Value contains the generic value.Description: The Note element holds free text, typically for display by the processing application.
Content: AttributeID (Type: string) , AttributeUnit (Type: UOM)? , AttributeValue*
Description: The ObjectAttribute element provides customizable data regarding the overall catalog, catalog administration, configured schema category, or product description that are not in elements that already exist in the CatalogHeader, SchemaCategory, or Product.
AttributeID identifies the custom attribute. It must be unique among attributes present in a particular SchemaCategory when used in that context. 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.AttributeUnit holds an ISO unit of measure, describing the basic unit for the attribute, as appropriate to what the attribute describes.AttributeValue gives the value of the attribute being described. For example, if the attribute is "Color", the value is "Red". Multiple values may be specified, each with its own xml:lang value.Description: The AttributeValue element gives the value of the attribute being described. For example, if the attribute is "Color", the value is "Red". Multiple values may be specified, each with its own xml:lang value.
lang language for the text description.Content: OrderHeader , OrderDetail? , OrderSummary?
Description: The Order element comprises the creation of a purchase order that is sent for acceptance or rejection by a seller. A requisitioner, buyer, or buying organization can initiate an Order in response to a variety of factors in the electronic business arena, contracts, auctions, order requests, etc. A requisitioner, or buyer, can initiate a change to an already existing order. A seller uses the OrderResponse document to accept or reject an Order or a changed order.
OrderHeader contains the header information of the Order.OrderDetail contains the line item and package details of the Order.OrderSummary contains the summary information of the Order, typically totals of numerical fields.Content: RequestedShipByDate (Type: datetime)? , RequestedDeliverByDate (Type: datetime)? , PromiseDate (Type: datetime)? , ValidityDates? , CancelByDate (Type: datetime)? , ListOfDateCoded?
Description: The OrderDates element is used to hold a list of the pertinent dates for the purchase order dates will include validity dates, RequestedShipDate, CancelByDates, among others. These dates act as defaults that may be overwritten at the item level or package level in the body of the message.
RequestedShipByDate is the date items in the purchase order must be shipped from the seller.RequestedDeliverByDate is the date items in the purchase order must be received by the buyer.PromiseDate is used mainly for confirming orders when a date was promised by the supplier over the phone.ValidityDates contains the dates between which the Order is effective.CancelByDate is the date after which Order should be cancelled.ListOfDateCoded contains all other dates not for the Order not explicitly stated as the content of other elements.Content: ListOfItemDetail , ListOfPackageDetail?
Description: The OrderDetail element contains the line item and package details of the Order.
ListOfItemDetail contains a list of line items for the Order.ListOfPackageDetail contains a list of package details for the Order.Content: OrderNumber , OrderIssueDate (Type: datetime) , OrderReferences? , ReleaseNumber (Type: string)? , Purpose , RequestedResponse? , OrderType? , OrderCurrency (Type: Currency) , TaxAccountingCurrency (Type: Currency)? , OrderLanguage (Type: Language) , OrderTaxReference (Type: TaxReference)? , OrderInvoiceMediumTypeCoded (Type: OrderInvoiceMediumTypeCode)? , OrderInvoiceMediumTypeCodedOther (Type: string)? , OrderDates? , OrderParty , PartLocation (Type: string)? , ListOfTransport? , OrderTermsOfDelivery (Type: TermsOfDelivery)? , OrderHeaderPrice (Type: ListOfPrice)? , OrderPaymentInstructions (Type: PaymentInstructions)? , OrderAllowancesOrCharges (Type: ListOfAllowOrCharge)? , OrderHeaderNote (Type: string)? , ListOfStructuredNote? , OrderHeaderAttachments (Type: ListOfAttachment)?
Description: The OrderHeader element contains the header information of the order.
OrderNumber is the unique number assigned to the Order, typically according to the system that generated the Order.OrderIssueDate holds a time stamp provided by the application that created the Order document.OrderReferences contains external references to the Order that are important to the processing and use of the Order.ReleaseNumber is the element used if the purchase order is a release against the document specified in the ContractReference under the order reference.Purpose is used to communicate the purpose of the Order.RequestedResponse specifies the type of acknowledgment requested by the buyer from the seller.OrderType identifies the type of Order being transmitted.OrderCurrency identifies the default currency of the Order, which when used at the header level may be overwritten at the lower level within the structure.TaxAccountingCurrency identifies the tax accounting currency for the Order if different than the OrderCurrency .OrderLanguage identifies the language of the Order.OrderTaxReference identifies the default tax information for the Order.OrderInvoiceMediumTypeCoded is used to describe the type of invoice required for this Order.OrderInvoiceMediumTypeCodedOther is used to provide a non-standard OrderInvoiceMediumTypeCode. This element is mandatory if the value of OrderInvoiceMediumTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OrderDates is used to hold a list of the pertinent dates for the Order - dates include validity dates, RequestedShipDate, CancelByDates, among others. These dates apply to the entire order, acting as defaults and that may be overwritten at the item level or package level in the body of the message.OrderParty holds information on the parties for the order, including unique ID's and address information.PartLocation is used when a supplier has multiple warehouses.ListOfTransport provides information on the movement of the goods including carrier, equipment and service level instructions.OrderTermsOfDelivery defines the terms of delivery for the Order.OrderHeaderPrice is the pricing information for the Order. This is the default price and can be overwritten at the item level.OrderPaymentInstructions holds the payment instructions for the Order.OrderAllowancesOrCharges contains the allowances and/or charges for the whole Order. These may include goods and shipping charges. Additional allowance or charges may be present at lower levels of the Order.OrderHeaderNote describes any free form text pertinent to the entire document described by the Order or to the Order 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.OrderHeaderAttachments holds a list of attachments applicable to the entire Order, or a large part of the consignment it describes. This information is not specific to a particular line item or package unless specifically noted.Content: BuyerOrderNumber (Type: string) , SellerOrderNumber (Type: string)? , ListOfMessageID?
Description: The OrderNumber element is a unique number assigned to the Order in respect to the parties assigning the number.
BuyerOrderNumber is the unique number assigned by the buyer to the Order.SellerOrderNumber is the unique number assigned by the seller to the Order.ListOfMessageID contains one or more identifiers for a message.Description:
This code identifies the medium type of the message. This code list is derived from EDIFACT 3153 (CommunicationChannel Identification, Coded) and X12 1019 (Invoice Type Code)
Value: Enumeration, including:
Content: BuyerParty (Type: Party) , BuyerTaxInformation (Type: PartyTaxInformation)? , SellerParty (Type: Party) , SellerTaxInformation (Type: PartyTaxInformation)? , ShipToParty (Type: Party)? , BillToParty (Type: Party)? , RemitToParty (Type: Party)? , ShipFromParty (Type: Party)? , WarehouseParty (Type: Party)? , SoldToParty (Type: Party)? , ManufacturingToParty (Type: Party)? , MaterialIssuer (Type: Party)? , ListOfPartyCoded?
Description: The OrderParty element holds all party information related to ordering goods.
BuyerParty contains the information for the party purchasing the goods.BuyerTaxInformation describes the taxing information for the buying party.SellerParty identifies the party selling the goods.SellerTaxInformation describes the taxing information for the selling party.ShipToParty contains the information for the party which the items are to be shipped.BillToParty contains the information for the party that will receive the bill for the goods..RemitToParty contains the information for the party to be paid.ShipFromParty contains party information identifying the location from which the items are to be shipped.WarehouseParty contains party information identifying the warehouse from which the items are to be shipped.SoldToParty contains party information identifying the location where the items were sold.ManufacturingToParty contains the party information identifying the location where the item is to be or is being manufactured.MaterialIssuer contains the information identifying the location that is issuing the request for the material.ListOfPartyCoded is a collection of all other party information not explicitly stated as the content of another element.Content: AccountCode (Type: Reference)? , ContractReferences (Type: ListOfContract)? , QuoteReference (Type: Reference)? , OtherOrderReferences (Type: ListOfReferenceCoded)?
Description: The OrderReferences element defines the references for the Order.
AccountCode is the unique identification assigned to the buyer by the seller. This is used for reference purposes in the transaction. For example, Buyer Company A has a standing account with Seller Company B, which is assigned the identification of A-127654, therefore A-127654 would be the AccountCode.ContractReferences is an element that holds the contract number and contract type for referencing a contract. This element can also be used to hold a reference to a standing order. In this case do not use the ContractType field.QuoteReference refers to a Quote ID or Shopping Cart ID.OtherOrderReferences is all other references to the Order not explicitly stated as the content of other elements.Content: OrderReferences+
Description: The ListOfOrderReferences element is a list of order references.
OrderReferences defines the references for the Order.Content: OrderRequestHeader , OrderRequestDetail (Type: OrderDetail)? , OrderRequestSummary (Type: OrderSummary)?
Description: The OrderRequest element comprises ordering information that is a result of a buyer's inquiry to purchase. A supplier initiates an OrderRequest to a requisitioner that is a result of a buyer's inquiry into a purchase of the supplier's goods. The requisitioner's approval of this OrderRequest results in the creation of a purchase order. There is not a response to the OrderRequest. Any changes to the OrderRequest will be represented in the Order.
OrderRequestHeader contains the header information of the OrderRequest.OrderRequestDetail is the container element to hold line item and package item details.OrderRequestSummary contains the summary information of the OrderRequest, typically totals of numerical fields.Content: OrderRequestNumber? , OrderRequestIssueDate (Type: datetime) , OrderRequestReferences (Type: OrderReferences)? , Purpose? , RequestedResponse? , OrderRequestCurrency (Type: Currency) , TaxAccountingCurrency (Type: Currency)? , OrderRequestLanguage (Type: Language) , OrderRequestTaxReference (Type: TaxReference)? , OrderInvoiceMediumTypeCoded (Type: OrderInvoiceMediumTypeCode)? , OrderInvoiceMediumTypeCodedOther (Type: string)? , OrderRequestDates (Type: OrderDates)? , OrderRequestParty , ListOfTransport? , OrderTermsOfDelivery (Type: TermsOfDelivery)? , OrderHeaderPrice (Type: ListOfPrice)? , OrderPaymentInstructions (Type: PaymentInstructions)? , OrderAllowancesOrCharges (Type: ListOfAllowOrCharge)? , OrderHeaderNote (Type: string)? , ListOfStructuredNote? , OrderHeaderAttachments (Type: ListOfAttachment)?
Description: The OrderRequestHeader element contains the header information of the OrderRequest.
OrderRequestNumber is the unique number assigned to the PurchaseOrder in respect to the parties assigning the number.OrderRequestIssueDate holds a digital time stamp provided by the application that created the OrderRequest document.OrderRequestReferences is used to hold a list of all other documents pertinent to this OrderRequest.Purpose is used to communicate the purpose of the OrderRequest document.RequestedResponse specifies the type of acknowledgment requested by the buyer from the seller.OrderRequestCurrency identifies the default currency of the OrderRequest, which when used at the header level may be overwritten at a lower level within the structure at line item level.TaxAccountingCurrency identifies the currency to be used for tax accounting purposes. This element is mandatory when the tax accounting currency is not the same as the InvoiceCurrency.OrderRequestLanguage identifies the language of the document.OrderRequestTaxReference identifies the default tax information for the order.OrderInvoiceMediumTypeCoded is used to describe the type of invoice required for this purchase order.OrderInvoiceMediumTypeCodedOther is used to provide a non-standard OrderInvoiceMediumTypeCode. This element is mandatory if the value of OrderInvoiceMediumTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OrderRequestDates is used to hold a list of the pertinent dates for the purchase order. Dates include validity dates, RequestedShipDate, CancelByDates, among others. These dates are global and apply to the entire order.OrderRequestParty holds information on the parties for the OrderRequest, including unique ID's and address information.ListOfTransport provides information on the movement of the goods including carrier, equipment and service level instructions.OrderTermsOfDelivery defines the terms of delivery for the Order.OrderHeaderPrice is the pricing information for the Order. This can be overwritten at the item level.OrderPaymentInstructions holds the payment instructions of the Order.OrderAllowancesOrCharges request or identifies a service, promotion, allowance, or charge; to specify the amount or percentage for the service, promotion, allowance, or charge.OrderHeaderNote contains any free-form text pertinent to the entire Order. 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.OrderHeaderAttachments contains a list of attachments applicable to the entire Order. The information is not specific to a particular line item or package, unless specifically noted.Content: BuyerOrderRequestNumber (Type: string) , SellerOrderRequestNumber (Type: string)? , ListOfMessageID?
Description: The OrderRequestNumber element is the unique number assigned to the PurchaseOrder in respect to the parties assigning the number.
BuyerOrderRequestNumber is the unique number assigned by the buyer to this OrderRequest.SellerOrderRequestNumber is he unique number assigned by the seller to this OrderRequest.ListOfMessageID contains one or more identifiers for a message.Content: BuyerParty (Type: Party)? , BuyerTaxInformation (Type: PartyTaxInformation)? , SellerParty (Type: Party) , SellerTaxInformation (Type: PartyTaxInformation)? , ShipToParty (Type: Party)? , BillToParty (Type: Party)? , RemitToParty (Type: Party)? , ShipFromParty (Type: Party)? , ListOfPartyCoded?
Description: The OrderRequestParty element holds information on the parties for the OrderRequest, including unique ID's and address information.
BuyerParty contains the information for the entity purchasing the goods.BuyerTaxInformation describes the taxing information for the buying party.SellerParty contains the information for the entity selling the goods.SellerTaxInformation describes the taxing information for the selling party.ShipToParty is the party that is receiving the goods or services.BillToParty describes the party to receive the invoice.RemitToParty contains the information for the party will be paid..ShipFromParty contains party information identifying the location from which the items are to be shipped.ListOfPartyCoded contains information relevant to describing parties other than the source target parties which are relevant to the time series data.Content: OrderResponseHeader , OrderResponseDetail? , OrderResponseSummary?
Description: The OrderResponse element is used to respond at the application level to an order or change order that has been received.
OrderResponseHeader contains the header information of the OrderResponse.OrderResponseDetail is an optional section used to repeat the detail section of the Order as it is, make changes to line item details or packaging details, or both. This should be used in accordance with the OrderHeaderResponseCode selected in the OrderResponseHeader.OrderResponseSummary contains the summary information of the OrderResponse.Content: ListOfOrderResponseItemDetail? , ListOfOrderResponsePackageDetail?
Description: The OrderResponseDetail element is an optional section used to repeat the detail section of the Order as it is, make changes to line item details or packaging details, or both. This should be used in accordance with the OrderHeaderResponseCode selected in the OrderResponseHeader..
ListOfOrderResponseItemDetail contains a list of response information for one or more line item details.ListOfOrderResponsePackageDetail holds response information for the package detail information.Content: OrderResponseNumber , OrderResponseIssueDate (Type: datetime) , OrderResponseDocTypeCoded (Type: OrderResponseDocTypeCode) , OrderResponseDocTypeCodedOther (Type: string)? , OrderReference (Type: Reference) , ChangeOrderReference (Type: Reference)? , SellerParty (Type: Party) , BuyerParty (Type: Party) , ListOfReferenceCoded? , Purpose , ResponseType , (OriginalOrderHeader (Type: OrderHeader) | ChangeOrderHeader)? , OrderHeaderChanges (Type: OrderHeader)? , OrderResponseHeaderNote (Type: string)? , ListOfStructuredNote?
Description: The OrderResponseHeader element contains the header information of the OrderResponse.
OrderResponseNumber is the unique number that identifies the OrderResponse, typically according to the system that generated the OrderResponse.OrderResponseIssueDate holds a time stamp provided by the application that created the OrderResponse.OrderResponseDocTypeCoded identifies the type of OrderResponse being sent.OrderResponseDocTypeCodedOther is used to provide a non-standard OrderResponseDocTypeCode. This element is mandatory if the value of OrderResponseDocTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OrderReference is the purchase order number that the OrderResponse document is referencing. This includes the number and the date of the purchase order.ChangeOrderReference is used for tracking purposes only. If the document is in response to a ChangeOrder, the ChangeOrderResponse document transmission can be identified here.SellerParty contains the information for the party selling the goods.BuyerParty contains the information for the entity purchasing the goods.ListOfReferenceCoded contains all other references for the OrderResponse not explicitly stated as the content of other elements.Purpose is used to communicate the purpose of a document.ResponseType defines the type of response sent between seller and buyer.OriginalOrderHeader is a place to insert a copy of the original OrderHeader for comparison against changes. This is useful in calculating differences between the original OrderHeader of the changed OrderHeader. It generally will not be used.ChangeOrderHeader is a place to insert a copy of the original ChangeOrderHeader for comparison against changes.OrderHeaderChanges is used to make any changes to the OrderHeader.Note: If header level changes are made, the user of this document must repeat the entire OrderHeader element to include the changes.
OrderResponseHeaderNote contains any free form text pertinent to the entire OrderResponse. This element may contain notes or 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: BuyerOrderResponseNumber (Type: string) , SellerOrderResponseNumber (Type: string)? , ListOfMessageID?
Description: The OrderResponseNumber element is the unique number that identifies the OrderResponse, typically according to the system that generated the OrderResponse.
BuyerOrderResponseNumber is the unique number assigned by the buyer to this OrderResponse.SellerOrderResponseNumber is the unique number assigned by the seller to this OrderResponse.ListOfMessageID contains one or more identifiers for a message.Description:
This code identifies the response document type.
Value: Enumeration, including:
Content: ItemDetailResponseCoded (Type: DetailResponseCode) , ItemDetailResponseCodedOther (Type: string)? , PriceErrorInfo (Type: ErrorInfo)? , AvailabilityErrorInfo (Type: ErrorInfo)? , ListOfErrorInfo? , ListOfReferenceCoded? , (OriginalItemDetail (Type: ItemDetail) | ChangeOrderItemDetail)? , ItemDetailChanges (Type: ItemDetail)? , LineItemNote (Type: string)? , ListOfStructuredNote?
Description: The OrderResponseItemDetail element holds response information for a line item, any references for that line item, and the relevant response to that line item. Applications will be expected to return any line items with any changes and generally all of the accepted line items as well. Any line item not present in this section that was found in the original order will be assumed to be accepted as is.
ItemDetailResponseCoded is used to identify the response for the line item detail.ItemDetailResponseCodedOther is used to provide a non-standard ItemDetailResponseTypeCode. This element is mandatory if the value of ItemDetailResponseTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PriceErrorInfo is optional error information related to price.AvailabilityErrorInfo is optional error information related to quantity.ListOfErrorInfo contains all other error information not explicitly stated as the content of other elements.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.OriginalItemDetail is used to send the original information for the line item. This is useful for comparisons, but will rarely be used.ChangeOrderItemDetail is used to send the ChangeOrder detail section from the ChangeOrder the seller is responding to. OriginalItemDetail is used to send the original information for the line item. If this is not used, then either OriginalItemDetail or ItemDetailChanges must be used.ItemDetailChanges is used to make changes to a line item detail. Note: If a change is made to a line item, the entire line item must be completely repeated again. if this is not used, then either OriginalItemDetail or ChangeOrderItemDetail must be used.LineItemNote describes any free-form text pertinent to the line item described by the OrderResponse. 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: OrderResponseItemDetail+
Description: The ListOfOrderResponseItemDetail element contains response information for one or more item details.
OrderResponseItemDetail holds response information for a line item, any references for that line item, and the relevant response to that line item. Applications will be expected to return any line items with any changes and generally all of the accepted line items as well. Any line item not present in this section that was found in the original order will be assumed to be accepted as is.Content: PackageDetailResponseCoded (Type: DetailResponseCode) , PackageDetailResponseCodedOther (Type: string)? , (OriginalPackageDetail (Type: PackageDetail) | ChangeOrderPackageDetail)? , PackageDetailChanges (Type: PackageDetail)? , PackageDetailNote (Type: string)?
Description: The OrderResponsePackageDetail element contains response information for the package detail. This includes a response code for the package detail and elements to repeat the original PackageDetail and to change the PackageDetail.
PackageDetailResponseCoded contains the response for the PackageDetail.PackageDetailResponseCodedOther is used to provide a non-standard PackageDetailResponseCode. This element is mandatory if the value of PackageDetailResponseCoded 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.ChangeOrderPackageDetail is used to send the PackageDetail of the ChangeOrder.PackageDetailChanges is used to make changes to the PackageDetail. Note: If a change is made to a package detail line, the entire package detail line must be completed again to reflect the changes made.PackageDetailNote contains any free form text pertinent to the package. 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 could be used to explicitly state the changes that were made to the PackageDetail.Content: OrderResponsePackageDetail+
Description: The ListOfOrderResponsePackageDetail element holds response information for the package detail information.
OrderResponsePackageDetail contains response information for the package detail. This includes a response code for the package detail and elements to repeat the original package detail and to change the package detail.Content: ErrorInfo? , OriginalOrderSummary (Type: OrderSummary)? , RevisedOrderSummary (Type: OrderSummary)?
Description: The OrderResponseSummary element contains the summary information of the OrderResponse.
ErrorInfo is a container for the error details.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: AccountCode (Type: Reference)? , BuyerReferenceNumber (Type: Reference) , SellerReferenceNumber (Type: Reference) , OtherReference (Type: ListOfReferenceCoded)? , OrderDate (Type: datetime) , ListOfOrderStatusItem?
Description: The OrderStatusReference element identifies the order the status is being requested for.
AccountCode holds the unique identification assigned to the buyer by the seller.BuyerReferenceNumber holds the purchase order number assigned by the buyer.SellerReferenceNumber holds the seller's order number.OtherReference provides any other reference to the order.OrderDate provides the date of the order.ListOfOrderStatusItem is a container holding the line item information.Content: OrderStatusRequestHeader , OrderStatusRequestDetail? , OrderStatusRequestSummary?
Description: The OrderStatusRequest element is the root element for requesting the status of an Order. OrderStatusRequest is sent from a buyer to a supplier. The request is only used to request the status of goods.
OrderStatusRequestHeader holds all OrderStatusRequest header-level information. This element occurs once within the document.OrderStatusRequestDetail contains the line item and package detail for the OrderStatusRequest.OrderStatusRequestSummary contains the details summarizing the OrderStatusRequest.Content: ListOfOrderStatusRequestDetail
Description: The OrderStatusRequestDetail element contains the line item and package detail for the OrderStatusRequest.
ListOfOrderStatusRequestDetail contains the list of order status request details.Content: OrderStatusDetailRequest+
Description: The ListOfOrderStatusRequestDetail element contains the list of order status request details.
OrderStatusDetailRequest contains the order status detail information.Content: OrderStatusReference , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The OrderStatusDetailRequest element contains the order status detail information.
OrderStatusReference identifies the order the status is being requested for.GeneralLineItemNote contains any free-form text pertinent to the line item in OrderStatusRequest. 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 OrderStatusRequest item.Content: OrderStatusRequestID (Type: Reference) , OrderStatusIssueDate (Type: datetime) , OrderStatusParty (Type: OrderParty) , OrderStatusLanguage (Type: Language)? , OrderStatusRequestNote (Type: string)? , OrderStatusListOfAttachment (Type: ListOfAttachment)?
Description: The OrderStatusRequestHeader element holds all OrderStatusRequest header-level information. This element occurs once within the document.
OrderStatusRequestID contains a reference number to identify the OrderStatusRequest document.OrderStatusIssueDate indicates the date the OrderStatusRequest is transmitted.OrderStatusParty holds information relating to the parties involved in the OrderStatusRequest.OrderStatusLanguage identifies the language for OrderStatusRequest.OrderStatusRequestNote contains any free-form text pertinent to the entire OrderStatusRequest. 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.OrderStatusListOfAttachment contains a list of attachments applicable to the entire OrderStatusRequest. The information is not specific to a particular line item or package, unless specifically noted.Content: TotalNumberOfLineItem (Type: int)?
Description: The OrderStatusRequestSummary element contains the details summarizing the OrderStatusRequest.
TotalNumberOfLineItem contains summary information for OrderStatusRequest. This includes the total number of line items.Content: OrderStatusResultHeader , OrderStatusResultDetail? , OrderStatusResultSummary?
Description: The OrderStatusResult element is the root element that holds the OrderStatusResult response to an OrderStatusRequest. This element occurs once within the document.
OrderStatusResultHeader holds all OrderStatusResult header-level information. This element occurs once within the document.OrderStatusResultDetail contains the line item detail for the OrderStatusResult.OrderStatusResultSummary contains the summary information of the OrderStatusResult.Content: OrderStatusCheckItemError (Type: int) , OrderStatusSummaryErrorInfo (Type: ErrorInfo)? , TotalNumberOfLineItem (Type: int)?
Description: The OrderStatusResultSummary element contains the summary information of the OrderStatusResult.
OrderStatusCheckItemError contains the summary information for the OrderStatusResult which includes error information and number of line items.OrderStatusSummaryErrorInfo contains the completion codes and messages, severity codes, and other error information.TotalNumberOfLineItem contains the total number of line items.Content: ListOfOrderStatusResultDetail
Description: The OrderStatusResultDetail element contains the detail information for the OrderStatusResult.
ListOfOrderStatusResultDetail contains a list of line items for the OrderStatusResult.Content: OrderStatusDetailResult+
Description: The ListOfOrderStatusResultDetail element contains a list of line items for the OrderStatusResult.
OrderStatusDetailResult contains the OrderStatus detail information.Content: OrderStatusResultReference , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The OrderStatusDetailResult element contains the OrderStatus detail information.
OrderStatusResultReference contains external references to the OrderStatusResult that are important to the processing and use of the OrderStatusResult.GeneralLineItemNote contains any free-form text pertinent to the line item in OrderStatusResult. 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 OrderStatusResult item.Content: OrderStatusID (Type: Reference) , OrderStatusIssueDate (Type: datetime) , OrderStatusResultParty (Type: OrderParty) , OrderStatusResultLanguage (Type: Language)? , OrderStatusResultNote (Type: string)? , ResultListOfAttachment (Type: ListOfAttachment)?
Description: The OrderStatusResultHeader element holds all OrderStatusResult header-level information. This element occurs once within the document.
OrderStatusID contains a reference number to identify the OrderStatusRequest document.OrderStatusIssueDate indicates the date for which status was requested.OrderStatusResultParty holds information relating to the supplier who is the receiver of the OrderStatusRequest.OrderStatusResultLanguage identifies the language of the OrderStatusResult.OrderStatusResultNote contains any free-form text pertinent to the entire OrderStatusResult. 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.ResultListOfAttachment contains a list of attachments applicable to the entire OrderStatusResult. The information is not specific to a particular line item or package, unless specifically noted.Content: AccountCode (Type: Reference)? , BuyerReferenceNumber (Type: Reference) , SellerReferenceNumber (Type: Reference) , OtherReference (Type: ListOfReferenceCoded)? , OrderDate (Type: datetime) , OrderStatusDate (Type: datetime) , OrderStatus (Type: Status) , ListOfOrderStatusResultItem?
Description: The OrderStatusResultReference element contains external references to the OrderStatusResult that are important to the processing and use of the OrderStatusResult.
AccountCode holds the unique identification assigned to the buyer by the seller.BuyerReferenceNumber holds the purchase order number assigned by the buyer.SellerReferenceNumber holds the sellers order number.OtherReference provides any other reference to the order.OrderDate holds the date of the order.OrderStatusDate holds the date of the result of the status request.OrderStatus provides the status details.ListOfOrderStatusResultItem contains a list of line items for the OrderStatusResult.Content: NumberOfLines (Type: int)? , TotalTax (Type: MonetaryValue)? , TotalAmount (Type: MonetaryValue)? , TransportPackagingTotals? , SummaryNote (Type: string)?
Description: The OrderSummary element contains the summary information of the order, typically totals of numerical fields.
NumberOfLines identifies the number of line items.TotalTax contains the total tax amount for the Order.TotalAmount contains the total price for the entire Order.TransportPackagingTotals is a summary of transport and packaging information if included in the Order.SummaryNote contains any free form text for the OrderSummary. This element may contain notes or any other similar information that is not contained explicitly in the another structure. You should not assume that the receiving application is capable of doing more than storing and/or displaying this information.Content: OrderTypeCoded (Type: OrderTypeCode) , OrderTypeCodedOther (Type: string)?
Description: The OrderType element identifies the type of purchase order the ChangeOrder is referencing.
OrderTypeCoded defines the type of order. Typically the value is Stand Alone.OrderTypeCodedOther is used to provide a non-standard OrderTypeCode. This element is mandatory if the value of OrderTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of the order message. This code list is derived from EDIFACT 1001 (Document Code Name) and X12 92 (Purchase Order Type Code)
Value: Enumeration, including:
Content: AddressType? , ExternalAddressID (Type: string) , POBox? , Street (Type: string)? , HouseNumber (Type: string)? , StreetSupplement1 (Type: string)? , StreetSupplement2 (Type: string)? , PostalCode (Type: string)? , City (Type: string) , County (Type: string)? , Region? , District (Type: string)? , Country , TradingPartnerTimezone (Type: Timezone)?
Description: The OrganizationAddress element indicates all relevant address information for an organization.
AddressType contains the function of the address.ExternalAddressID is a GUID that is used for referencing the address when specifying specific user info (unique within the partner organization) This field is used to determine stored records for updating of address information. The trading partner is responsible for managing the uniqueness of the external Ids that they supply to the trading partner directory.POBox contains the post office box number.Street holds the street name (inline house number allowed). Either Street or POBox must be represented.HouseNumber contains the house number or range of numbers.StreetSupplement1 contains any additional information to identify the street.StreetSupplement2 contains any further additional information to identify the street.PostalCode contains the identifier for one or more properties according to the postal service of that country.(Zip-Code in US).City contains the name of the city.County contains the name of the county. This can be used for TaxJurisdicationCode determination. E,g, 'Santa Clara County'.Region contains the name of the region within a country specific to this address. This is used to hold the state in US addresses.This element must be present when TaxJurisdictionCode has been entered.District contains the name of the district. This element is only used for those countries that have these sub-elements.Country holds the identifier of the country.TradingPartnerTimezone contains the off-set from Greenwich Mean Time that the organization operates to.Content: PrimaryOrganizationAddress (Type: OrganizationAddress) , ListOfOrganizationAddress?
Description: The OrganizationAddresses element provides all the address information for an organization.
PrimaryOrganizationAddress is the organization's primary address.ListOfOrganizationAddress contains all relevant address information for the organization.Content: OrganizationAddress+
Description: The ListOfOrganizationAddress element is a list of organization addresses.
OrganizationAddress contains all relevant address information for the organization.Content: PackageID (Type: int) , ListOfItemReference (Type: ListOfOrderReferences)? , ListOfPackageMark? , ListOfPackageCharacteristic? , ListOfDimension? , ListOfPackageDescription? , TransportReference (Type: int)? , SpecialHandling? , HazardousPackaging (Type: Hazardous)? , AssociatedDocuments? , ShippingInstructions (Type: string)? , ReturnableContainerInfo? , PackageDetail*
Description: The Package element contains information about the specifics of the collection of packages being described by the PackageDetail element. If the collection of packages all contain the same things, and there is no need to identify specifically which packages are contained in which, the only one Package element should be use. If the contents of the package differ or if there needs to be a distinction between which package a sub package is contained in, then multiple Package elements should be used.
PackageID is used to identify a particular container within the document domain for references from line item detail. (package detail is a recursive element-packages contain other packages- consequently within each package the sub packages is determined by being nested inside its parent.ListOfItemReference lists all of the line items that are contained in the package.ListOfPackageMark indicates how the package should be marked. This could be used to identify common markings on a collection of packages.ListOfPackageCharacteristic describes the characteristics of a packages.ListOfDimension describes the physical dimensions of the package.ListOfPackageDescription is a list of package descriptions used to identify individual packages. If only one package is being described by the Package element, then only one PackageDescription is used. If a collection of packages is being described, then multiple descriptions can be used to uniquely identify the packages within the collection.TransportReference references the transport routing element to identify which transport legs the package is travelling on.SpecialHandling describes any special handling relating to the package.HazardousPackaging includes all hazardous regulations regarding to the package. Identification of the instructions on how specified goods, packages or containers should be handled.AssociatedDocuments identifies documents with information related to the hazardous packaging of this order.ShippingInstructions is free form text for special shipping instructions.ReturnableContainerInfo describes shipping, payment and miscellaneous information regarding containers that are returned after they have been used in shipment.PackageDetail is recursive, to indicate sub-package relationships.Content: PackageCharacteristicCoded (Type: PackageCharacteristicCode) , PackageCharacteristicCodedOther (Type: string)? , PackageCharacteristicDescription (Type: Identifier)
Description: The PackageCharacteristic element contains the code and the description of the packaging characteristics.
PackageCharacteristicCoded specifies the marking, packaging, loading and related characteristics being described.PackageCharacteristicCodedOther is used to provide a non-standard PackageCharacteristicCode. This element is mandatory if the value of PackageCharacteristicCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PackageCharacteristicDescription holds a code from an industry code list which provides specific data about the marking, packaging, or loading and unloading of a product.Content: PackageMarkCoded (Type: PackageMarkCode) , PackageMarkCodedOther (Type: string)? , PackageMarkValue (Type: string)?
Description: The PackageMark element specifies the type and value of markings on packages.
PackageMarkCoded indicates how the package is marked or is to be marked.PackageMarkCodedOther is used to provide a non-standard PackageMarkCode. This element is mandatory if the value of PackageMarkCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PackageMarkValue is the value of the package mark, company or bar code, free text, etc.Content: PackageCharacteristic+
Description: The ListOfPackageCharacteristic element contains one or more PackageCharacteristic elements.
PackageCharacteristic contains the code and the description of the packaging characteristics.Content: PackageMark+
Description: The ListOfPackageMark element contains one or more PackageMark elements.
PackageMark specifies the type and value of markings on packages.Content: ListOfDocumentLoose? , ListOfDocumentAttached?
Description: The AssociatedDocuments element identifies documents with information related to the hazardous packaging of this order.
ListOfDocumentLoose identifies documents significant to the packaging that are not attached to the package.ListOfDocumentAttached identifies documents significant to the packaging that are attached to the package.Content: DocumentLoose (Type: PackageDoc)+
Description: The ListOfDocumentLoose element identifies documents significant to the packaging that are not attached to the package.
DocumentLoose is a string content model with attributes of DocumentTypeCoded and DocumentTypeCodedOther.Content: DocumentAttached (Type: PackageDoc)+
Description: The ListOfDocumentAttached element identifies documents significant to the packaging that are attached to the package.
DocumentAttached contains information about the attached documents.Content: DocumentTitle (Type: string)?
Attribute: Name: DocumentTypeCoded - Data Type: DocumentTypeCode - Default Value: #REQUIREDDescription: The PackageDoc element describes a document that is included with a package.
DocumentTitle holds the title of the loose document.DocumentTypeCoded contains the code for the loose document.DocumentTypeCodedOther is used to provide a non-standard DocumentTypeCode. This element is mandatory if the value of DocumentTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Package+
Description: The ListOfPackage element is used to describe one or more Package element as necessary by the complexity of the use of PackageDetail element.
Package contains information about the specifics of the collection of packages being described by the PackageDetail element. If the collection of packages all contain the same things, and there is no need to identify specifically which packages are contained in which, the only one Package element should be use. If the contents of the package differ or if there needs to be a distinction between which package a sub package is contained in, then multiple Package elements should be used.Description:
This code identifies the characteristics of the package. This codelist is derived from X12 753 (packaging characteristic code).
Value: Enumeration, including:
Content: ListOfPackageIdentifier? , ContainerCounter (Type: string)? , LoadOrderCounter (Type: int)?
Description: The PackageDescription element identifies specific information relating to an individual package. Includes the package identifier, the container counter, and the load order counter.
ListOfPackageIdentifier is a list of the identifiers for the individual package.ContainerCounter identifies the package sequence with respect to its location to the inner and outer packages.LoadOrderCounter identifies the order in which this package was placed inside it's container. Can also be used to identify locations in a compartmentalized tank car or a pallet, such 3p or 2nd from brake.Content: PackageIdentifierCoded (Type: PackageIdentifierCode) , PackageIdentifierCodedOther (Type: string)? , PackageIdentifierValue (Type: string)?
Description: The PackageIdentifier element is the identifier on the package that is unique in relation to other packages.
PackageIdentifierCoded contains the identifier on the package.PackageIdentifierCodedOther is used to provide a non-standard PackageIdentifierCode. This element is mandatory if the value of PackageIdentifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PackageIdentifierValue identifies the value of the identifier. This should be the unique value.Content: PackageIdentifier+
Description: The ListOfPackageIdentifier element is a list of the identifiers for the individual package.
PackageIdentifier is the identifier on the package that is unique in relation to other packages.Content: PackageDescription+
Description: The ListOfPackageDescription element is a list of package descriptions. To be used to identify individual packages.
PackageDescription identifies specific information relating to an individual package. Includes the package identifier, the container counter, and the load order counter.Description:
This code identifies the type of barcode that is used to identify a package.
Value: Enumeration, including:
Content: PackageType , NumberOfPackages (Type: int) , ListOfPackage?
Description: The PackageDetail element is the packaging information at the detail level for the items, packages, and equipment. This also provides information on hazardous materials, returnable containers, and marks and numbers. This is used to describe a collection of packages of the same type. For instance, a collection of multiple pallets would be described by one PackageDetail element. The PackageDetail element is recursive to allow for sub packaging descriptions. For instance, if a collection of boxes are contained on a pallet, the first recurrence of the PackageDetail element would describe the boxes that are contained on the pallet.
PackageType is a container element that identifies and describes the kind of package that the PackageDetail element represents.NumberOfPackages identifies the number of packages that are being described by the PackageDetail element. For example, if the PackageDetail element is describing five pallets, then the NumberOfPackages would be 5.ListOfPackage is used to describe the specifics of one or more packages being described by the PackageDetail element.Content: PackageDetail+
Description: The ListOfPackageDetail element is a container to hold one or more PackageDetail elements.
PackageDetail is the packaging information at the detail level for the items, packages, and equipment. This also provides information on hazardous materials, returnable containers, and marks and numbers. This is used to describe a collection of packages of the same type. For instance, a collection of multiple pallets would be described by one PackageDetail element. The PackageDetail element is recursive to allow for sub packaging descriptions. For instance, if a collection of boxes are contained on a pallet, the first recurrence of the PackageDetail element would describe the boxes that are contained on the pallet.Description:
This code list is derived from EDIFACT 4233 and 7405 and X12 88
Value: Enumeration, including:
Content: PackageTypeCoded (Type: PackageTypeCode) , PackageTypeCodedOther (Type: string)? , PackageTypeDescription (Type: ListOfDescription)?
Description: The PackageType element is a container element that identifies and describes the kind of package.
PackageTypeCoded identifies the kind of packaging using a standard codelist.PackageTypeCodedOther is used to provide a non-standard PackageTypeCode. This element is mandatory if the value of PackageTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PackageTypeDescription describes the material used for packaging using free form text.Content: PackageType+
Description: The ListOfPackageType element is a container element that identifies and describes the kind of package.
PackageType identifies and describes the material used for packaging.Description:
This code list is derived from EDIFACT 7065 REC 21 and X12 103
Value: Enumeration, including:
Content: PartID (Type: string) , PartIDExt (Type: string)?
Description: The PartNum element is a complete identification for a product or service.
PartID is the basic identification for a product or service.PartIDExt provides additional identification for a product or service. An example of this would be a color code for a specific product.Content: PartNum+
Description: The ListOfPartNum element a list of one or more part numbers.
PartNum is a part number.Content: ProductIdentifierQualifierCoded (Type: ProductIdentifierQualifierCode) , ProductIdentifierQualifierCodedOther (Type: string)? , ProductIdentifier (Type: string) , ProductIdentifierExt (Type: string)?
Description: The ProductIdentifierCoded element is an identification of a product or service where the source or function of the identification is not explicitly stated by another element.
ProductIdentifierQualifierCoded qualifies a product or service identification using a standard codelist.ProductIdentifierQualifierCodedOther is used to provide a non-standard ProductIdentifierQualifierCode. This element is mandatory if the value of ProductIdentifierQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ProductIdentifier contains a basic identification for a product or service in text format.ProductIdentifierExt contains and extension to the basic identification for a product or service. This can be used to supply a color code for a specific product.Content: ProductIdentifierCoded+
Description: The ListOfProductIdentifierCoded element contains one or more identifications of a product or service where the source or function of the identification is not explicitly stated in another element.
ProductIdentifierCoded is an identification of a product or service where the source or function of the identification is not explicitly stated by another element.Content: PartNumbers? , ItemDescription (Type: string)? , ListOfItemCharacteristic? , CommodityCode (Type: Identifier)?
Description: The ItemIdentifiers element details all of the part numbers, descriptions, and characteristics of an item.
PartNumbers identifies all identification numbers for the item.ItemDescription is a free form field that can be used to give a text description of the item.ListOfItemCharacteristic is a collection of physical attributes other than dimensions of an item.CommodityCode harmonized (HS) system code. This is the international notation to categorize individual commodities. These are also known as customs codes.Content: SellerPartNumber (Type: PartNum)? , BuyerPartNumber (Type: PartNum)? , ManufacturerPartNumber? , StandardPartNumber (Type: ProductIdentifierCoded)? , SubstitutePartNumbers (Type: ListOfProductIdentifierCoded)? , OtherItemIdentifiers (Type: ListOfProductIdentifierCoded)?
Description: The PartNumbers element identifies all identification numbers for the item.
SellerPartNumber is the identification of a product or service as assigned by the seller of the product or service.BuyerPartNumber is the identification of a product or service as assigned by the buyer.ManufacturerPartNumber is the identification of a product as assigned by the manufacturer of the product and identification of the manufacturer.StandardPartNumber is commonly accepted identification of a product or service that is assigned by a standards agency.SubstitutePartNumbers is a collection of identifications of products or services that are acceptable substitutions for the product of service identified in the PartNumbers element.OtherItemIdentifiers is a collection of any other identifications of the product or service identified by the PartNumbers element that are not explicitly stated as the content of the other elements contained in the PartNumbers element.Extends: PartNum
Description: The ManufacturerPartNumber element is the identification of a product as assigned by the manufacturer of the product and identification of the manufacturer.
ManufacturerID is the identification of the manufacturer as assigned by a standards agency.Content: Partner+
Description: The ListOfPartners element identifies suppliers, manufacturers used by this catalog, and, potentially, buyers for whom this catalog is targeted.
Partner identifies and describes a partner who uses or is mentioned in the catalog.Content: Party?
Attribute: Name: PartnerID - Data Type: ID - Default Value: #IMPLIEDDescription: The Partner element has an optional PartnerID attribute that is an XML ID. Although the PartnerID attribute is optional, an ID must be present as either the PartnerID or in the Party subelement. The ID in the Party subelement takes precedence over the PartnerID.
Party identifies an entity doing business and the relevant information pertaining to it.PartnerID has a value that is an XML ID. Although the PartnerID attribute is optional, an ID must be present as either the PartnerID or in the Party subelement. The ID in the Party subelement takes precedence over the PartnerID.Relationship identifies the type of partner relationship.Value: Enumeration, including:
Content: PartyID (Type: Identifier) , ListOfIdentifier? , MDFBusiness (Type: boolean)? , NameAddress? , OrderContact (Type: Contact)? , ReceivingContact (Type: Contact)? , ShippingContact (Type: Contact)? , OtherContacts (Type: ListOfContact)? , CorrespondenceLanguage (Type: Language)?
Description: The Party element identifies an entity doing business and the relevant information pertaining to it.
PartyID is a standard identification of an entity doing business as assigned by a standards agency.ListOfIdentifier is a collection of all other identifications of the party being described by the Party element.MDFBusiness is an indicator of whether the party is a minority, disadvantaged, or female owned business.NameAddress contains the name and address information for the entity being described by the Party element.OrderContact provides the name and contact information of the person responsible for communication pertaining to an order.ReceivingContact provides the name and contact information of the person responsible for communication pertaining to the receipt of goods.ShippingContact provides the name and contact information of the person responsible for communication pertaining to the shipment of goods.OtherContacts is a collection of name and contact information for any other communication purposes not explicitly stated in the Party element.CorrespondenceLanguage identifies the language in which all correspondences with the entity identified by the Party should be.Extends: Party
Description: The PartyCoded element identifies an entity doing business not explicitly stated as the content of another element with its role and the relevant information pertaining to the entity.
PartyRoleCoded identifies the function or role of the entity in relation to a document.PartyRoleCodedOther is used to provide a non-standard PartyRoleCode. This element is mandatory if the value of PartyRoleCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Party+
Description: The ListOfParty element is a collection of entities doing business and the relevant information pertaining to them.
Party identifies an entity doing business and the relevant information pertaining to it.Content: PartyCoded+
Description: The ListOfPartyCoded element is a collection of all other party information not explicitly stated as the content of another element.
PartyCoded identifies an entity doing business not explicitly stated as the content of another element with its role and the relevant information pertaining to the entity.Description:
This code identifies the party role of the person relating to the package. This code list is derived from EDIFACT 3035 (party function code qualifier) and X12 98 (entity identifier code).
Value: Enumeration, including:
Content: TaxIdentifier (Type: Identifier)? , RegisteredName (Type: string)? , RegisteredOffice (Type: string)? , TaxLocation (Type: Location)? , CompanyRegistrationNumber (Type: string)?
Description: The PartyTaxInformation element describes the tax information for a party.
TaxIdentifier is the tax identifier or registration number of the party. The agency that allocated this identifier is dependent on the tax jurisdiction of the party. Can also be referred to as the tax exemption or certificate number.RegisteredName is the name of the party as registered with the tax authority. This must be present if a) the tax regulations require it, and b) it is different from the Name element in the NameAddress element of the party.RegisteredOffice is the registered office of the party. This must be present if a) the tax regulations require it, and b) it is different from the Address element in the NameAddress element of the party.TaxLocation holds the tax location.CompanyRegistrationNumber is the company registration number of the party. This must be present if tax regulations require it.Extends: Party
Description: The PayerParty element describes the partner that is responsible for payment. This is assumed to also be the sender of the document. For PayerParty, the Party definition is extended to include CertificateAuthority.
CertificateAuthority contains the payer's certificate of authority or digital signature which will be used by the financial institution to verify the origins of the document and validate the payment.Content: PaymentDueDate (Type: datetime)? , RequestedPaymentDate (Type: datetime)? , PayBeforeDate (Type: datetime)? , ListOfPaymentDates (Type: ListOfDateCoded)?
Description: The PaymentDates element contains a list of dates that are pertinent to the payment document.
PaymentDueDate specifies the date that the payment is due.RequestedPaymentDate specifies the date that the financial institution is requested to process the payment.PayBeforeDate specifies the date on or before the date that the financial institution should make the payment to the payee. PaymentRequest becomes invalid if payment is not made on or before this date.ListOfPaymentDates contains all other dates for the PaymentRequest not explicitly stated as the content of other elements.Description:
This code contains exception codes that relate to the Payment document.
Value: Enumeration, including:
Content: PaymentTerms+ , PaymentMethod+
Description: The PaymentInstructions element contains the terms and the method of payment for goods or services received.
PaymentTerms is used to communicate one or more of the terms relating to the instructions for payment of goods or services received.PaymentMethod communicates the specific manner in which a payment is to be made.Content: PaymentInstructions+
Description: The ListOfPaymentInstructions element is a collection of one or more elements to communication the terms and the method of payment for goods or services received.
PaymentInstructions contains the terms and the method of payment for goods or services received.Description:
This code identifies the type of payment to be made for the package. This code list is derived from EDIFACT 4461 (payment means code) and X12 107 (payment method code).
Value: Enumeration, including:
Content: PaymentMeanCoded (Type: PaymentMeanCode) , PaymentMeanCodedOther (Type: string)? , PaymentMeanReference (Type: Reference)? , PaymentSystemCoded (Type: PaymentSystemCode)? , PaymentSystemCodedOther (Type: string)? , OriginatingFIAccount (Type: FIAccount)? , ReceivingFIAccount (Type: FIAccount)? , CardInfo?
Description: The PaymentMethod element communicates the specific manner in which a payment is to be made.
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.PaymentMeanReference identifies specific information relating to the specified payment mean. For example, if the selected payment mean were check, then PaymentMeanReference would be used to communicate the check number.PaymentSystemCoded indicates the system through which the payment is processed using a standard codelist.PaymentSystemCodedOther is used to provide a non-standard PaymentSystemCode. This element is mandatory if the value of PaymentSystemCoded is 'Other'. These codes should not contain white space unless absolutely necessary.OriginatingFIAccount contains information for the financial institution and associated account details from which the funds are originating (Payer's bank details).ReceivingFIAccount contains information for the financial institution and associated account details to which the funds are being sent (Payee's bank details).CardInfo contains details of the credit or debit card that is being used for the payment.Description:
This identifies the system over which the payment will be transmitted. This code list is derived from EDIFACT 4435 (Payment channel code).
Value: Enumeration, including:
Content: PayerParty , PayeeParty (Type: Party) , BuyerParty (Type: Party)? , SupplierParty (Type: Party)? , BillToParty (Type: Party)? , ListOfPartyCoded?
Description: The PaymentParty element contains all parties relevant to the payment document. The required parties are the PayerParty and the PayeeParty. The PayerParty includes an optional CertificateAuthority field to specify a digital signature.
PayerParty describes the partner that is responsible for payment. This is assumed to also be the sender of the document. For PayerParty, the Party definition is extended to include CertificateAuthority.PayeeParty describes the party to receive payment.BuyerParty describes the buyer of the goods or services.SupplierParty describes the supplier of the goods or services.BillToParty describes the party to receive the invoice.ListOfPartyCoded contains information relevant to describing parties other than the source target parties which are relevant to the time series data.Description:
This code identifies the reason or business function for the payment. This code list is derived from EDIFACT 4025 (Business function code).
Value: Enumeration, including:
Content: PaymentRequestHeader , ListOfPaymentRequestDetail , PaymentRequestSummary
Description: The PaymentRequest element consists of details for arranging for payment of a specified value amount to a beneficiary in settlement of a business transaction. The payer can initiate a PaymentRequest to instruct its financial institution to debit its account by the specified amount to be paid to the beneficiary for goods or services rendered. The PaymentRequest can reference multiple documents (i.e. PO, ASN, Invoice) but no reference is mandatory. The payment is expressed in a single language. Consolidated payment is supported. The Payer can send multiple payment requests in a single PaymentRequest document. Foreign exchange rates are supported. This is not an IFX compliant document; however IFX influenced the design of this document.
PaymentRequestHeader contains the header information of the PaymentRequest.ListOfPaymentRequestDetail contains a list of payment documents which include details and instructions for payment. Each payment document can optionally have RemittanceAdviceDetail. This is a required element with at least one payment document.PaymentRequestSummary contains the summary information of the PaymentRequest typically totals of numeric fields.Content: PaymentRequestDetail+
Description: The ListOfPaymentRequestDetail element contains a list of payment documents which include details and instructions for payment. Each payment document can optionally have RemittanceAdviceDetail. This is a required element with at least one payment document.
PaymentRequestDetail contains details and instructions for the payment request. This may include, for example, settlement amount, receiving financial institution detail, payment reason and payment mean codes, and payment dates.Content: ConfirmationID (Type: string) , PaymentDocumentID (Type: Reference) , PaymentSequenceNo (Type: int)? , SettlementAmount (Type: MonetaryValue)? , DebitAmount (Type: MonetaryValue)? , CreditAmount (Type: MonetaryValue)? , PaymentParty? , FinancialInstitutionDetail? , ListOfRateOfExchangeDetail? , ExcpetionNote (Type: string)? , PaymentRequestNote (Type: string)? , ListOfPaymentException? , EncryptedInfo?
Description: The PaymentRequestAcknDetail element contains high level information for the PaymentRequest document.
ConfirmationID contains the confirmation ID to acknowledge the receipt of the PaymentRequest document. This value is sent by the financial institution and should be used in the future to reference the payment.PaymentDocumentID contains a unique identifier for the payment document.PaymentSequenceNo contains a counter to track the payment document in the case where the PaymentRequest contains more than one payment document.SettlementAmount contains the monetary amount to be paid as specified in the PaymentRequest document. This is the requested payer amount specified by the Payer.DebitAmount specifies the amount banks actually debit from payer's account.CreditAmount specifies the amount banks actually credit to the payee's account.PaymentParty contains all parties relevant to the payment document. The required parties are the PayerParty and the PayeeParty. The PayerParty includes an optional CertificatAuthority field to specify a digital signature.FinancialInstitutionDetail contains specifications for the financial institution information which includes both account specific detail (i.e., account ID, account type, account holder) and financial institution specific detail (i.e., bank ID, branch ID). Financial institution information must be provided for the originating bank and associated account detail and the receiving bank and associated account detail.ListOfRateOfExchangeDetail contains one or more elements detailing information on the rate of exchange between currencies.ExcpetionNote contains any free form text pertinent to the specify exceptions. 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.PaymentRequestNote contains any free form text pertinent to the PaymentRequest document. 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.ListOfPaymnetException" contains a list of exceptions for the PaymentRequestAcknowledgement.EncryptedInfo contains a placeholder to store customer or bank specific encrypted fields.Content: PaymentRequestAcknDetail+
Description: The ListOfPaymentRequestAcknDetail element contains a list of one or more payment document details for which the PaymentRequestAcknowledgement is referencing from the original PaymentRequest document.
PaymentRequestAcknDetail contains high level information for the PaymentRequest document.Content: PaymentException+
Description: The ListOfPaymentException element contains a list of exception codes relating to thePaymentRequest document.
PaymentException contains exception details which include an exception code, exception note and a specifier for the offending element..Content: PaymentExceptionCoded (Type: PaymentExceptionCode) , PaymentExceptionCodedOther (Type: string)? , PaymentExceptionNote (Type: string)? , OffendingPaymentElement (Type: NameValuePair)?
Description: The PaymentException element holds the exception details that include an exception code, exception note and a specifier for the offending element.
PaymentExceptionCoded contains exception codes that relate to the PaymentRequest document.PaymentExceptionCodedOther is used to provide a non-standard PaymentExceptionCode. This element is mandatory if the value of PaymentExceptionCoded is 'Other'. These codes should not contain white space unless absolutely necessary. .PaymentExceptionNote contains any free form text pertinent to the PaymentException. 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. .OffendingPaymentElement specifies the name and value of the element for which the exception applies.Content: PaymentRequestAcknCoded (Type: PurposeCode) , PaymentRequestAcknCodedOther (Type: string)? , PaymentRequestAcknIssueDate (Type: datetime) , PaymentRequestAcknID (Type: string) , PaymentRequestIDReference (Type: Reference)? , CertificateAuthority (Type: string)? , SuccessfulReceptIndicator (Type: boolean) , GeneralNote (Type: string)? , Language
Description: The PaymentRequestAcknHeader element contains information to acknowledge receipt of a PaymentRequest document.
PaymentRequestAcknCoded indicates the intended function of the PaymentRequestAcknowledgment document.PaymentRequestAcknCodedOther is used to provide a non-standard PaymentRequestAcknCode. This element is mandatory if the value of PaymentRequestAcknCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PaymentRequestAcknIssueDate holds the time stamp provided by the application that created the PaymentRequestAcknowledgment document.PaymentRequestAcknID indicates the unique number assigned to the PaymentRequestAckn typically according to the system that generated the document.PaymentRequestIDReference contains the payer's PaymentRequestID number from the PaymentRequest document.CertificateAuthority contains the payer's certificate of authority or digital signature which will be used by the financial institution to verify the origins of the document and validate the payment.SuccessfulReceiptIndicator indicates whether or not the PaymentRequest document was successfully received.True PaymentRequest was successfully received
False PaymentRequest was NOT successfully received
GeneralNote contains any free-form text pertinent to the PaymentRequestAcknHeader. 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.Language specifies the language used in the PaymentRequestAcknowledgment document. This is an ISO language code list.Content: PaymentRequestAcknHeader , ListOfPaymentRequestAcknDetail , PaymentRequestAcknSummary (Type: PaymentRequestSummary)
Description: The PaymentRequestAcknowledgment element acknowledges the receipt of the PaymentRequest.
PaymentRequestAcknHeader contains information to acknowledge receipt of a PaymentRequest document.ListOfPaymentRequestAcknDetail contains a list of one or more payment document details for which the PaymentRequestAcknowledgement is referencing from the original PaymentRequest document.PaymentRequestAcknSummary contains summary information for the PaymentRequestAcknowledgment document.Content: PaymentDocumentID (Type: Reference) , PaymentSequenceNo (Type: int)? , PaymentDates? , (FinancialInstitutionDetail | (OriginatingFinancialInstitution (Type: FIAccountDetail) , ReceivingFISpecificID (Type: Party)) , (OriginatingFISpecificID (Type: Party) , (ReceivingFinancialInstitution (Type: FIAccountDetail) | ReceivingFISpecificID (Type: Party))) , CardInfo) , SettlementAmount (Type: MonetaryValue) , SettlementCurrency (Type: Currency) , PaymentRequestParty , LegalReportingInformation? , PaymentReasonCoded (Type: PaymentReasonCode)? , PaymentReasonCodedOther (Type: string)? , PaymentUrgencyCoded (Type: PaymentUrgencyCode)? , PaymentUrgencyCodedOther (Type: string)? , InternationalPaymentIndicator (Type: boolean)? , IntraCompanyPaymentIndicator (Type: boolean)? , PaymentMeanCoded (Type: PaymentMeanCode) , PaymentMeanCodedOther (Type: string)? , PaymentMeanReference (Type: Reference)? , PaymentSystemCoded (Type: PaymentSystemCode)? , PaymentSystemCodedOther (Type: string)? , PaymentReference (Type: ListOfReferenceCoded)? , AcceptFXMarketRate (Type: boolean)? , ListOfRateOfExchangeDetail? , PaymentDetailAttachment (Type: Attachment)? , PaymentInstructionNotes (Type: string)? , IsCredit (Type: boolean)? , RepetitiveCode (Type: string)? , FinancialChargesAllocation? , ListOfPaymentDocumentDetail?
Description: The PaymentRequestDetail element contains details and instructions for the PaymentRequest. This may include, for example, settlement amount, receiving financial institution detail, payment reason and payment mean codes, and payment dates.
PaymentDocumentID contains a unique identifier for the payment document.PaymentSequenceNo contains a counter to track the payment document in the case where the PaymentRequest document contains more than one payment document.PaymentDates contains a list of dates that are pertinent to the payment document.FinancialInstitutionDetail contains specifications for the financial institution information which includes both account specific detail (i.e., account ID, account type, account holder) and financial institution specific detail (i.e., bank ID, branch ID).OriginatingFinancialInstitution contains the financial institution account information of the originating bank. The account detail and financial institution detail are required.ReceivingFISpecificID contains a bank specified ID to identify the payee information. This includes optional payee details such as address and contact. This can be an internal identifier assigned by the bank or possibly an MPID.OriginatingFISpecificID contains a bank specified ID to identify the payer information. This includes optional payee details such as address and contact. This can be an internal identifier assigned by the bank or possibly an MPID.ReceivingFinancialInstitution contains the financial institution account information for the receiving bank. The account detail and financial institution detail is required.ReceivingFISpecificID contains a bank specified ID to identify the payee information. This includes optional payee details such as address and contact. This can be an internal identifier assigned by the bank or possibly an MPID.CardInfo contains details of the credit or debit card that is being used for the payment. This includes credit card number, card type, card holder name, expiration date and other pertinent information.SettlementAmount specifies the monetary amount to be paid.SettlementCurrency specifies the currency for the PaymentRequest document. This is the currency in which the payment will be made. This is an ISO currency code list.PaymentRequestParty contains all parties relevant to the payment document. The PayerParty is optional in this structure.LegalReportingInformation contains legal reporting information associated with payments made to a foreign payee. This is used by central banks for processing cross border payments over a certain amount.Countries where used: Austria, Belgium, Germany, Denmark, Finland, Japan, Netherlands, Norway, Sweden
PaymentReasonCoded specifies the business purpose of the payment.PaymentReasonCodedOther is used to provide a non-standard PaymentReasonCode. This element is mandatory if the value of PaymentReasonCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PaymentUrgencyCoded specifies the priority of the payment document.PaymentUrgencyCodedOther is used to provide a non-standard PaymentUrgencyCode. This element is mandatory if the value of PaymentUrgencyCoded is 'Other'. These codes should not contain white space unless absolutely necessary.InternationalPaymentIndicator contains a boolean indicator to specify whether the payment is an cross border payment.True is an international payment
False is not an international payment
IntraCompanyPaymentIndicator contains a boolean indicator to specify if the payment is an intra-company transaction.True is an intra-company payment
False is not an intra-company payment
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.PaymentMeanReference identifies specific information relating to the specified payment mean. For example, if the selected payment mean were check, then PaymentMeanReference would be used to communicate the check number.PaymentSystemCoded indicates the system through which the payment is processed using a standard codelist.PaymentSystemCodedOther is used to provide a non-standard PaymentSystemCode. This element is mandatory if the value of PaymentSystemCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PaymentReference contains a list of documents, business transactions, or identifiers that are relevant to the PaymentRequest.AcceptFXMarketRate specifies whether the payer is willing to accept an FI supplied market rate for payment.ListOfRateOfExchangeDetail contains one or more elements detailing information on the rate of exchange between currencies.PaymentDetailAttachment contains an attachment relevant to the payment request transaction.PaymentInstructionNotes contains any free-form text pertinent to the PaymentInstructionDetail. 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.IsCredit contains a boolean value to indicate whether the amount is a credit or debit.RepetitiveCode describes a company specific payment transaction code which a payer and the financial institution agree upon for fixed payments. The code is used to indicate the determined set of payer and payee accounts from which the funds will be transferred to or from. The financial institutions require this code to validate, transact, and bill properly.FinancialChargesAllocation contains information pertaining to how payment of fees will be allocated between partners.ListOfPaymentDocumentDetail contains the RemittanceAdvice details. Remittance detail is not required to process a payment. Thus, usage of this element is dependent on the established trading partner agreements between sender and receiver of this document.Content: PaymentDocumentDetail (Type: RemittanceAdviceDetail)+
Description: The ListOfPaymentDocumentDetail element contains the RemittanceAdvice details. Remittance detail is not required to process a payment. Thus, usage of this element is dependent on the established trading partner agreements between sender and receiver of this document.
PaymentDocumentDetail contains detail information pertaining to the RemittanceAdvice.The structure is composed of Adjustments, Subsidiary and/or Invoicing Document
(Adjustments+ | InvoicingDetail+ | Subsidiary)
Users can specify adjustment information only in the case where the remittance detail is for payment of a single invoice. The adjustment structure contains details of the line item, adjustment amounts, and adjustment reasons.
A subsidiary can be specified in the case where the invoicing is performed by a central/parent company. Each subsidiary contains invoicing document information that details the goods/services that were issued along with relevant adjustment information.
An invoicing detail contains invoice information (originating from an invoice, ASN, purchase order, etc.) at the line item level. Any relevant adjustment detail is also included.
Content: PaymentRequestPurpose (Type: Purpose) , PaymentRequestIssueDate (Type: datetime) , PaymentRequestID (Type: Reference) , PayerParty , Language , GeneralNotes (Type: string)? , PaymentRequestAttachment (Type: Attachment)?
Description: The PaymentRequestHeader element contains the header information of the PaymentRequest.
PaymentRequestPurpose indicates the intended use of the PaymentRequest document.PaymentRequestIssueDate holds the time stamp provided by the application that created the PaymentRequest document.PaymentRequestID specifies a unique identifier for the PaymentRequest document.PayerParty describes the partner that is responsible for payment. This is assumed to also be the sender of the document. For PayerParty, the Party definition is extended to include CertificateAuthority.Language identifies the language of the RemittanceAdvice.GeneralNotes contains any free-form text pertinent to the entire PaymentRequest. 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.PaymentRequestAttachment holds an attachment applicable to the entire PaymentRequest,and is not specific to a particular item.Content: PayerParty? , PayeeParty (Type: Party) , BuyerParty (Type: Party)? , SupplierParty (Type: Party)? , BillToParty (Type: Party)? , ListOfPartyCoded?
Description: The PaymentRequestParty element contains all parties relevant to the payment document. The PayerParty is optional in this structure.
PayerParty describes the party responsible for payment. The PayerParty at the header level is the default payer. If this information is filled at the line level, then it overrides the header payer.PayeeParty describes the party to receive payment.BuyerParty describes the buyer of the goods or services.SupplierParty describes the supplier of the goods or services.BillToParty describes the party to receive the invoice.ListOfPartyCoded contains information relevant to describing parties other than the source target parties which are relevant to the time series data.Content: TotalPaymentDocuments (Type: int)? , TotalLineItem (Type: int)? , TotalSettlementAmount (Type: MonetaryValue)? , EncryptedInfo? , SummaryNote (Type: string)?
Description: The PaymentRequestSummary element contains the summary information of the PaymentRequest typically totals of numeric fields.
TotalPaymentDocuments contains the total number of payment documents included in the payment request.TotalLineItem contains the total number of line item details given in the PaymentRequestDetails.TotalSettlementAmount contains the total amount of payment requested.EncryptedInfo contains a placeholder to store customer or bank specific encrypted fields.SummaryNote contains any free-form text pertinent to the PaymentRequestSummary. 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.Description:
This code identifies which party pays for the package. This code list is derived from EDIFACT 8395 (Returnable package freight payment responsibility code) and X12 743 (Returnable container freight payment responsibility code).
Value: Enumeration, including:
Content: PaymentStatusRequestHeader , ListOfPaymentStatusRequestDetail , PaymentStatusRequestSummary
Description: The PaymentStatusRequest element enables payers to query the status of a previously submitted payment to/from a financial institution.
PaymentStatusRequestHeader contains the header information of the PaymentStatusRequest.ListOfPaymentStatusRequestDetail contains a list of PaymentStatusRequest details.PaymentStatusRequestSummary contains the summary information of the PaymentRequestStatus.Content: PaymentStatusRequestDetail+
Description: The ListOfPaymentStatusRequestDetail element contains a list of PaymentStatusRequest details.
PaymentStatusRequestDetail contains detailed information related to the payment status being requested.Content: SequenceNumber (Type: int)? , (PaymentRequestID (Type: Reference) | ConfirmationID (Type: string) | PaymentDateRange (Type: ValidityDates) | PaymentDates) , SettlementAmount (Type: MonetaryValue)? , ListOfPaymentRequestReferences (Type: ListOfReference)?
Description: The PaymentStatusRequestDetail element contains detailed information related to the payment status being requested.
SequenceNumber contains a sequence number to be used if there are multiple payments per document.PaymentRequestID contains a unique identifier assigned by the payer for the original PaymentRequest transaction.ConfirmationID contains the confirmation identifier of the payment. This is the unique identifier assigned by the financial institution for the original PaymentRequest transaction.PaymentDateRange contains a date range for which the payment status is being requested. This element is composed of a StartDate and an EndDate.PaymentDates contains a list of dates that are pertinent to the payment. This structure is composed of optional PaymentDueDate, RequestedPaymentDate, PayBeforeDate and ListOfPaymentDates.SettlementAmount specifies the monetary amount paid.ListOfPaymentRequestReferences contains a list of references that are relevant to the PaymentRequest detail.Content: PaymentStatusRequestID (Type: Reference) , PaymentStatusRequestIssueDate (Type: datetime) , PayerParty? , Language , GeneralNotes (Type: string)?
Description: The PaymentStatusRequestHeader element contains the header information of the PaymentStatusRequest.
PaymentStatusRequestID is the unique number assigned to the PaymentStatusRequest.PaymentStatusRequestIssueDate holds a time stamp provided by the application that created the PaymentStatusRequest.PayerParty contains information for the party that is responsible for payment. This is assumed to also be the sender of the document. The PayerParty includes an optional CertificateAuthority field to hold the payer's digital signature or certificate of authority.Language identifies the language of the PaymentStatusRequest.GeneralNotes contains any free form text pertinent to the entire PaymentStatusRequest or to the PaymentStatusRequest 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.Content: TotalNumberPaymentRequests (Type: int)?
Description: The PaymentStatusRequestSummary element contains the summary information of the PaymentRequestStatus.
TotalNumberPaymentRequests contains the total number of PaymentRequest documents for which a status update is required.Content: PaymentStatusResponseHeader , ListOfPaymentStatusResponseDetail , PaymentStatusResponseSummary (Type: PaymentStatusRequestSummary)
Description: The PaymentStatusResponse element . The payment status response document enables the financial institution to send the information on the status of a payment to the payer.
PaymentStatusResponseHeader contains the header information of the PaymentStatusResponse.ListOfPaymentStatusResponseDetail contains a list of PaymentStatusResponse details.PaymentStatusResponseSummary contains the summary information of the PaymentStatusResponse document.Content: PaymentStatusResponseDetail+
Description: The ListOfPaymentStatusResponseDetail element contains a list of PaymentStatusResponse details.
PaymentStatusResponseDetail contains detailed information pertaining to the payment status. This includes payment document information containing payment related information at the line item level.Content: PaymentRequestID (Type: Reference) , ConfirmationID (Type: string) , SequenceNumber (Type: int)? , PaymentDates? , SettlementDate (Type: datetime)? , FXValueDate (Type: datetime)? , SettlementAmount (Type: MonetaryValue)? , DebitAmount (Type: MonetaryValue)? , CreditAmount (Type: MonetaryValue)? , OriginatingFinancialInstitution (Type: FIAccountDetail)? , ReceivingFinancialInstitution (Type: FIAccountDetail)? , CardInfo? , PaymentParty? , ParticipantUserID (Type: Identifier)? , RateOfExchangeDetail? , PaymentSystemCoded (Type: PaymentSystemCode)? , PaymentSystemCodedOther (Type: string)? , ListOfPaymentReferences (Type: ListOfReference)? , ListOfOtherPaymentInfo (Type: ListOfNameValuePair)? , ListOfPaymentResponse (Type: ListOfPaymentException)
Description: The ListOfPaymentStatusResponseDetail element contains detailed information pertaining to the payment status. This includes payment document information containing payment related information at the line item level.
PaymentRequestID contains the unique identifier assigned by the payer for the original PaymentRequest transaction.ConfirmationID contains the confirmation identifier of the payment. This is the unique identifier assigned by the financial institution for the original PaymentRequest transaction.SequenceNumber contains a sequence number to be used when there are multiple payments per document.PaymentDates contains a list of dates that are pertinent to the payment. This structure is composed of optional PaymentDueDate, RequestedPaymentDate, PayBeforeDate and ListOfPaymentDates.SettlementDate contains the actual date that the transaction is settled.FXValueDate contains the date that a foreign exchange transaction is expected to settle.SettlementAmount identifies the monetary amount paid.DebitAmount identifies the monetary amount debited from the originating account.CreditAmount identifies the monetary amount credited to the receiving account.OriginatingFinancialInstitution contains the financial institution account information for the "From" bank.ReceivingFinancialInstitution contains the financial institution information for the "To" bank.CardInfo contains details for payments made via credit card. This includes credit card number, card type, card holder name, expiration date, and other pertinent information.PaymentParty contains all parties relevant to the payment transaction. The required parties are the PayerParty and the PayeeParty. The PayerParty includes an optional CertificateAuthority field to specify a digital signature.ParticipantUserID contains the user identification of the participant.RateOfExchangeDetail contains details relating to the foreign exchange.PaymentSystemCoded contains a code that indicates the system through which the payment was processed.PaymentSystemCodedOther is used to provide a non-standard PaymentSystemCode. This element is mandatory if the value of PaymentSystemCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfPaymentReferences contains a list of payment related references such as invoice numbers, purchase order numbers, dates etc.ListOfOtherPaymentInfo contains a set of generic name and values pairs that can be used to describe payment details not explicitly specified in this document.ListOfPaymentResponse contains a list of response codes relating to the PaymentRequest document. This includes both positive status response codes as well as error response codes.Content: PaymentStatusRequestID (Type: Reference) , PaymentStatusResponseID (Type: Reference) , PaymentStatusResponseIssueDate (Type: datetime) , SendingParty (Type: PayerParty)? , Language , GeneralNote (Type: string)?
Description: The PaymentStatusResponseHeader element contains the header information of the PaymentStatusResponse.
PaymentStatusRequestID is the unique number of the original PaymentStatusRequest.PaymentStatusResponseID is the unique number of the PaymentStatusResponse.PaymentStatusResponseIssueDate holds a time stamp provided by the application that created the PaymentStatusResponse.SendingParty contains details of the financial institution that is responsible for payment. This is assumed to also be the sender of the document. The PayerParty includes an optional CertificateAuthority field to hold the payer's digital signature or certificate of authority.Language identifies the language of the PaymentStatusResponse.GeneralNote contains any free form text pertinent to the entire PaymentStatusResponse or to the PaymentStatusResponse 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.Content: PaymentTermCoded (Type: PaymentTermCode) , PaymentTermCodedOther (Type: string)? , PaymentTermValue (Type: int)? , PaymentTermDetails (Type: Discounts)?
Description: The PaymentTerm element contains information about one payment condition, such as discount eligibility.
PaymentTermCoded identifies a payment condition using a standard code list.PaymentTermCodedOther is used to provide a non-standard PaymentTermCode. This element is mandatory if the value of PaymentTermCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PaymentTermValue specifies the value that pertains to the PaymentTermCode.PaymentTermDetails is used to communicate any discounts that may be associated with the payment term.Description:
This code identifies the a payment term. This code list is derived from EDIFACT 4279 (Payment terms type code qualifier) and X12 336 (Terms type code)
Value: Enumeration, including:
Content: PaymentTerm+ , Discounts* , PaymentTermsNote (Type: string)?
Description: The PaymentTerms element is used to communicate one or more of terms relating to the instructions for payment of goods or services received.
PaymentTerm contains details about one payment condition, such as discount eligibility.Discounts is used to communicate discounts that apply, but are not subject to any terms.PaymentTermsNote contains a note to further describe the payment terms.Content: DiscountPercent (Type: Decimal10_4)? , DiscountAmount (Type: MonetaryValue)? , DiscountDaysDue (Type: int)? , DiscountDueDate (Type: datetime)? , DiscountDateTimeRefCoded (Type: DateTimeRefCode)? , DiscountDateTimeRefCodedOther (Type: string)? , NetDaysDue (Type: int)? , NetDueDate (Type: datetime)? , NetDateTimeRefCoded (Type: DateTimeRefCode)? , NetDateTimeRefCodedOther (Type: string)?
Description: The Discounts element is a container element that holds discount information as it pertains to the payment term.
DiscountPercent contains the percent discounted in the terms of the payment. If a discount percent is specified then DiscountAmount should not be used.DiscountAmount contains the amount to be discounted from the payment value. If a discount amount is specified then DiscountPercent should not be used.DiscountDaysDue contains the number of days which the amount has to be paid by in order to receive the discount. This is only used in the case where the discount applies to a payment term.DiscountDueDate contains the date the amount has to paid by in order to receive the discount. This is only used in the case where the discount applies to a payment term.DiscountDateTimeRefCoded communicates the date of which the discount terms are based from using a standard codelist. For example, if the term specifies a discount is received if a payment is made before 15 days, the DiscountTimeRefCoded specifies the beginning date for the 15 day period to which the discount applies. This should be used if DiscountDaysDue is used. This is only used in the case where the discount applies to a payment term.DiscountDateTimeRefCodedOther is used to provide a non-standard DateTimeRefCode. This element is mandatory if the value of DiscountDateTimeRefCoded is 'Other'. These codes should not contain white space unless absolutely necessary.NetDaysDue specifies the number of days the amount has to be paid in full by. This is only used in the case where the discount applies to a payment term.NetDueDate contains the specific date that the payment is due in full. This is only used in the case where the discount applies to a payment term.NetDateTimeRefCoded communicates the date of which the net days due are based from using a standard codelist. For example, if the term specifies that the entire amount is to be paid within 30 days, the DiscountTimeRefCoded specifies the beginning date for the 30 day period. This should be used if NetDaysDue is used. This is only used in the case where the discount applies to a payment term.NetDateTimeRefCodedOther is used to provide a non-standard DateTimeRefCode. This element is mandatory if the value of NetDateTimeRefCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies whether the payment should be normal or express.
Value: Enumeration, including:
Content: (OrganizationAddressID (Type: string) | (POBox? , Street (Type: string)? , HouseNumber (Type: string)? , StreetSupplement1 (Type: string)? , StreetSupplement2 (Type: string)? , PostalCode (Type: string)? , City (Type: string) , County (Type: string)? , Region? , District (Type: string)? , Country)) , Building (Type: string)? , Floor (Type: string)? , RoomNumber (Type: string)? , InhouseMail (Type: string)? , Department (Type: string)? , ListOfCommunicationDetail
Description: The PersonAddress element contains a user-specific specified address within an organization. Organization address can be referenced as an option. Personal addresses that do not exist as corporate addresses will not be stored in the trading partner directory. Any address that is associated with a user is also a corporate address.
OrganizationAddressID can be used in place of the address information to reference an organizations address by the ID assigned to it.POBox contains the post office box number.Street holds the street name (inline house number allowed). Either Street or POBox must be represented.HouseNumber contains the house number or range of numbers.StreetSupplement1 contains any additional information to identify the street.StreetSupplement2 contains any further additional information to identify the street.PostalCode contains the identifier for one or more properties according to the postal service of that country.(Zip-Code in US).City contains the name of the city.County contains the name of the county. This can be used for TaxJurisdicationCode determination. E,g, 'Santa Clara County'.Region contains the name of the region within a country specific to this address. This is used to hold the state in US addresses.This element must be present when TaxJurisdictionCode has been entered.District contains the name of the district. This element is only used for those countries that have these sub-elements.Country contains the ISO-Code of country.Building contains the name of the building.Floor contains the number of the floor.RoomNumber contains the identifier for the room.InhouseMail contains the inhouse mail identifier.Department contains the department number or name.ListOfCommunicationDetail contains one or more CommunicationDetail elements.Content: PersonAddress+
Description: The ListOfPersonAddress element contains a list of one or more personal addresses.
PersonAddress contains a user-specific specified address within an organization. Organization address can be referenced as an option! Personal addresses that do not exist as corporate addresses will not be stored in the trading partner directory. Any address that is associated with a user is also a corporate address.Content: Title? , AcademicTitle? , LastName (Type: string) , FirstName (Type: string)? , MiddleName (Type: string)? , FullName (Type: string)? , CorrespondenceLanguage (Type: Language)? , NumberFormat (Type: string)? , DateFormat? , TimeFormat (Type: string)? , PersonTimezone (Type: Timezone)? , ListOfX509Certificate? , PersonAddress , GeneralNotes (Type: string)?
Description: The PersonProfile element contains the profile of the trading partner user.
Title contains the title of the user, related to gender and marital status.AcademicTitle contains the academic title of the user e.g. Dr.LastName contains the last or family name of user.FirstName contains the first or given name of user.MiddleName contains the middle name of the user if applicable.FullName contains the full name of the user. This is for display purposes on the application's user-interface.CorrespondenceLanguage identifies the language in which all correspondences with the entity identified by the Party should be.NumberFormat the format an application should use for display to this user.DateFormat the format an application should use for display to this user.TimeFormat the format an application should use for display to this user.PersonTimezone the timezone of the user for applications to use in adjusting the display.ListOfX509Certificate contains a list of one or more X509Certificate.PersonAddress contains a user-specific address within his organization.GeneralNotes contains any free-form text pertinent to the PersonProfile. 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: PlanningScheduleHeader , (ListOfLocationGroupedPlanningDetail | ListOfMaterialGroupedPlanningDetail) , PlanningScheduleSummary?
Description: The PlanningSchedule element is sent from a party who is planning the use or consumption of products (buyer) to a party who has to plan for the supply of the products (seller). The document consists of the notification of a forecast to be sent from the buyer to the seller. The document outlines the requirements regarding the details for short term delivery and/or medium to long scheduling for products. The scheduling can be used to authorize manufacturing and/or the provision of materials. This is based on the terms and conditions defined in a purchasing agreement commonly outlined by a contract or order. The Planning Schedule defined here will not be designed to support release capability. This document will serve solely as a materials requirement schedule. All schedule requirements relating to shipping and release authorization will be handled by the ShippingSchedule document. A response to Planning Schedule can be made using the PlanningScheduleResponse document. Use of this document is determined by trading partners.
PlanningScheduleHeader contains the header information of the Planning Schedule.ListOfLocationGroupedPlanningDetail contains the line level detail information for the PlanningSchedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the PlanningSchedule.ListOfMaterialGroupedPlanningDetail contains the line level detail information for the PlanningSchedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the PlanningSchedule.PlanningScheduleSummary contains the summary information of the PlanningSchedule, typically totals of numerical fields.Content: ScheduleID (Type: string) , ScheduleIssueDate (Type: datetime) , ScheduleReferences? , ReleaseNumber (Type: string)? , SchedulePurpose (Type: Purpose) , RequestedResponse? , ScheduleTypeCoded (Type: ScheduleTypeCode) , ScheduleTypeCodedOther (Type: string)? , QuantityQualifierCoded (Type: QuantityQualifierCode) , QuantityQualifierCodedOther (Type: string)? , ValidityDates? , ScheduleParty , Language , PlanningScheduleHeaderNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The PlanningScheduleHeader element contains the header information of the Planning Schedule.
ScheduleID is the unique number that uniquely identifies the PlanningSchedule, typically according to the system that generated the PlanningSchedule.ScheduleIssueDate is a digital time stamp by the application which created the PlanningSchedule document.ScheduleReferences is used to identify references to other documents and release information for the PlanningSchedule.ReleaseNumber identifies the specific iteration of the release against a given contract, purchase order, etc.SchedulePurpose indicates the purpose of the PlanningSchedule document.RequestedResponse specifies the type of acknowledgment requested by the buyer from the seller.ScheduleTypeCoded identifies the type of schedule when defining shipping or delivery time in a schedule or forecast.ScheduleTypeCodedOther is used to provide a non-standard ScheduleTypeCode. This element is mandatory if the value of ScheduleTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.QuantityQualifierCoded is the purpose of a quantity using a standard codelist.QuantityQualifierCodedOther is used to provide a non-standard QuantityQualifierCode. This element is mandatory if the value of QuantityQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ValidityDates is used to specify a start and end date of a period which the element in which they are used is valid.ScheduleParty contains information on the parties to the PlanningSchedule, including unique ID's and address information.Language identifies the language of the PlanningSchedule.PlanningScheduleHeaderNote contains any free-form text pertinent to the entire PlanningSchedule. 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 is a note that allows for an ID, URL, and a free-form note field.ListOfAttachment contains a list of attachments applicable to the entire PlanningSchedule. The information is not specific to a particular line item or package, unless specifically noted.Content: PlanningScheduleResponseHeader , (ListOfLocationGroupedPlanningResponse | ListOfMaterialGroupedPlanningResponse) , PlanningScheduleResponseSummary (Type: PlanningScheduleSummary)?
Description: The PlanningScheduleResponse element is the response to a previously sent PlanningSchedule. The intent of this document is for sellers to provide changes or corrections to the original documents. A seller can reply back with changes to a schedule due to factors such as backorder, insufficient parts, cannot meet demand, incorrect information, etc.
PlanningScheduleResponseHeader contains all PlanningScheduleResponse header-level information. This element occurs once within the document.ListOfLocationGroupedPlanningResponse contains the line level detail information for the PlanningSchedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the PlanningScheduleResponse document.ListOfMaterialGroupedPlanningResponse contains the line level detail information for the planning schedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the PlanningScheduleResponse document.PlanningScheduleResponseSummary contains the summary information of the PlanningScheduleResponse, typically totals of numerical fields.Content: ScheduleResponseID (Type: string) , ScheduleResponseIssueDate (Type: datetime) , ScheduleReference (Type: Reference) , ListOfReferenceCoded? , BuyerParty (Type: Party) , SellerParty (Type: Party) , Purpose , ResponseType , Language , OriginalPlanningScheduleHeader (Type: PlanningScheduleHeader)? , ChangedPlanningScheduleHeader (Type: PlanningScheduleHeader)? , PlanningScheduleResponseHeaderNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The PlanningScheduleResponseHeader element contains the header information of the PlanningScheduleResponse.
ScheduleResponseID contains a reference number to uniquely identify the PlanningScheduleResponse, typically according to the system that generated the PlanningScheduleResponse.ScheduleResponseIssueDate holds a digital time stamp provided by the application that created the PlanningScheduleResponse document.ScheduleReference is a reference to the original PlanningSchedule document.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.BuyerParty is the buyer of the goods or services.SellerParty is the seller of the goods or services.Purpose is used to communicate the purpose of a document.ResponseType identifies the type or response intended by the PlanningScheduleResponse document.Language identifies the language of the PlanningScheduleResponse .OriginalPlanningScheduleHeader used to hold the original PlanningScheduleHeader can be used if needed. This is useful for comparison reasons but will seldom be used.ChangedPlanningScheduleHeader holds any changes to the original PlanningScheduleHeader. Note: If there are changes to the header, the entire header section should be repeated with the changes.PlanningScheduleResponseHeaderNote contains any free-form text pertinent to the entire PlanningScheduleResponseHeader. 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 is a structured note which contains an identifier and URL.ListOfAttachment contains a list of attachments applicable to the document.Content: TotalNumberOfLineItems (Type: int)
Description: The PlanningScheduleSummary element contains the summary information of the PlanningSchedule, typically totals of numerical fields.
TotalNumberOfLineItems is the total number of line items in the PlanningSchedule.Content: UnitPrice , PriceBasisQuantity (Type: Quantity)? , ValidityDates? , PriceQuantityRange (Type: Quantity)? , PriceMultiplier?
Description: The Price element contains a pricing scheme for an item.
UnitPrice is a container element that holds the pricing information for a basic unit of an item.PriceBasisQuantity contains a quantity and unit of measurement to which the unit price applies if that quantity is greater than. For example if a pricing scheme were $50/500 lbs, then 500 lbs would be contained in this element. If this is used, then UnitOfMeasurement element in the UnitPrice element should not be used.ValidityDates specifies the start and end date for the pricing if a range dates applies to the pricing scheme.PriceQuantityRange contains a range of quantity over which the pricing information is applicable. This is commonly used for step pricing scenarios.PriceMultiplier contains a reason and value by which the unit price is multiplied by to arrive at the final price for an item. This can be used to apply a discount to a basic unit price.Content: UnitPriceValue (Type: Decimal21_6) , Currency? , UnitOfMeasurement?
Description: The UnitPrice element container element that holds the pricing information for a basic unit of an item.
UnitPriceValue contains the value of the unit price.Currency contains the currency that UnitPriceValue is expressed in.UnitOfMeasurement contains the unit of measurement that the unit price is based on. This is used if the PriceBasisQuantity is one. If this is used, PriceBasisQuantity should not be used.Content: PriceMultiplierCoded (Type: PriceMultiplierCode) , PriceMultiplierCodedOther (Type: string)? , Multiplier (Type: number)
Description: The PriceMultiplier element contains a reason and value by which the unit price is multiplied by to arrive at the final price for an item. This can be used to apply a discount to a basic unit price.
PriceMultiplierCoded specifies the function of the multiplier using a standard codelist.PriceMultiplierCodedOther is used to provide a non-standard PriceMultiplerCode. This element is only used if the value of PriceMultiplierCoded is 'Other' when it is mandatory.Multiplier contains a value by which the unit price is multiplied by to arrive at the final price for an item. For example, if the unit price is to be discounted by 10%, the value of PriceMultiplier would be 0.9 .Description:
This code identifies the reason for which a price is to be multiplied by a factor to obtain the final price. This code list is derived from EDIFACT 5393 (Price Multiplier Qualifier) and X12 648 (Price Multiplier Qualifier)
Value: Enumeration, including:
Content: Price+
Description: The ListOfPrice element contains one or more pricing schemes.
Price contains a pricing scheme for an item.Content: PriceCheckRequestHeader , PriceCheckRequestDetail? , PriceCheckRequestSummary?
Description: The PriceCheckRequest element consists of the request for a price to be sent from a buyer to a supplier. The request is only used to request the price of the goods.
PriceCheckRequestHeader holds all PriceCheck header-level information. This element occurs once within the document and contains reference date along with buyer and supplier information.PriceCheckRequestDetail contains the line item detail information for the PriceCheckRequest.PriceCheckRequestSummary contains summary information for the PriceCheckRequest. This includes totals of numerical fields.Content: ListOfPriceCheckRequestItemDetail
Description: The PriceCheckRequestDetail element contains the line item detail information for the PriceCheckRequest.
ListOfPriceCheckRequestItemDetail contains a list of line items for PriceCheckRequest.Content: TotalNumberOfLineItem (Type: int)?
Description: The PriceCheckRequestSummary element contains summary information for the PriceCheckRequest. This includes totals of numerical fields.
TotalNumberOfLineItem contains the total number of line items in the PriceCheckRequest.Content: PriceCheckRequestID (Type: Reference) , PriceCheckRequestIssueDate (Type: datetime) , SupplierParty (Type: Party) , SupplierIDReferenceDate (Type: datetime)? , BuyerParty (Type: Party) , BuyerIDReferenceDate (Type: datetime)? , PriceCheckShipToParty (Type: Party) , PriceCurrency (Type: Currency)? , QuoteDate (Type: datetime)? , PriceCheckRequestLanguage (Type: Language)? , PriceCheckRequestNotes (Type: string)? , RequestListOfAttachment (Type: ListOfAttachment)?
Description: The PriceCheckRequestHeader element holds all PriceCheck header-level information. This element occurs once within the document and contains reference date along with buyer and supplier information.
PriceCheckRequestID contains a reference number to identify the PriceCheckRequest document.PriceCheckRequestIssueDate indicates the date the PriceCheckRequest is transmitted.SupplierParty holds information relating to the supplier who is the receiver of the PriceCheckRequest. 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 initiator of the PriceCheckRequest.This includes unique ID's and address information.BuyerIDReferenceDate holds the date of the buyer ID reference.PriceCheckShipToParty 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.PriceCurrency identifies the default currency of the PriceCheckRequest, which when used at the header level may be overwritten at a lower level within the structure (line item level).QuoteDate is the date for which prices are being quoted.PriceCheckRequestLanguage identifies the language for the PriceCheckRequest.PriceCheckRequestNotes contains any free-form text pertinent to the entire PriceCheckRequest. 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.RequestListOfAttachment contains a list of attachments applicable to the entire PriceCheckRequest. The information is not specific to a particular line item unless specifically noted.Content: PriceCheckRequestBaseItemDetail , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The PriceCheckRequestItemDetail element contains the item detail information for the PriceCheckRequest .
PriceCheckRequestBaseItemDetail contains the identifying and descriptive information for the line items in PriceCheckRequest.GeneralLineItemNote describes any free-form text pertinent to the line item described by the PriceCheckRequestDetail. 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.LineItemAttachment contains details of the attachments for the line item.Extends: BaseItemDetail
Description: The PriceCheckRequestBaseItemDetail element contains the identifying and descriptive information for the line items in PriceCheckRequest.
PriceCheckRequestTransport contains transport information for the line item. Contains information about the method used to transport the item.Content: PriceCheckRequestItemDetail+
Description: The ListOfPriceCheckRequestItemDetail element contains a list of line items for PriceCheckRequest.
PriceCheckRequestItemDetail contains item detail for the PriceCheckRequest.Content: PriceCheckResultHeader , PriceCheckResultDetail? , PriceCheckResultSummary?
Description: The PriceCheckResult element consists of the response from a supplier to a PriceCheckRequest sent by a buyer. The PriceCheckResult contains specific price information for items in the PriceCheckRequest.
PriceCheckResultHeader holds all PriceCheck header-level information. This element occurs once within the document.PriceCheckResultDetail contains the line item detail information for the PriceCheckResult.PriceCheckResultSummary holds information about the errors generated during the price check and total number of line items.Content: ListOfPriceCheckResultItemDetail
Description: The PriceCheckResultDetail element contains the line item detail information for the PriceCheckResult.
ListOfPriceCheckResultItemDetail contains a list of line items for the PriceCheckResult.Content: PriceCheckItemError (Type: int) , PriceCheckSummaryErrorInfo (Type: ErrorInfo)? , TotalNumberOfLineItem (Type: int)?
Description: The PriceCheckResultSummary element holds information about the errors generated during the price check and total number of line items.
PriceCheckItemError contains the number of errors that occurred during the price check.PriceCheckSummaryErrorInfo contains the completion code and message, severity, and other error information.TotalNumberOfLineItem contains the total number of line items in the PriceCheckResult.Content: PriceCheckResultID (Type: Reference) , PriceCheckResultIssueDate (Type: datetime) , SupplierParty (Type: Party) , SupplierIDReferenceDate (Type: datetime)? , BuyerParty (Type: Party) , BuyerIDReferenceDate (Type: datetime)? , PriceCheckShipToParty (Type: Party) , PriceCheckCurrency (Type: Currency)? , QuoteDate (Type: datetime)? , PriceCheckResultLanguage (Type: Language)? , PriceCheckResultNote (Type: string)? , ResultListOfAttachment (Type: ListOfAttachment)?
Description: The PriceCheckResultHeader element holds all price check header-level information. This element occurs once within the document.
PriceCheckResultID contains a reference number to identify the PriceCheckResult document.PriceCheckResultIssueDate indicates the date the PriceCheckResult is transmitted.SupplierParty holds information from the supplier as a response to the PriceCheckRequest.SupplierIDReferenceDate holds the date of the supplier ID reference.BuyerParty holds information relating to the buyer who is the receiver of the PriceCheckResult.BuyerIDReferenceDate holds the date of the buyer ID reference.PriceCheckShipToParty 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.PriceCheckCurrency identifies the default currency of the PriceCheckResult which when used at the header level may be overwritten at a lower level within the structure (line item level).QuoteDate is the date for which prices are being quoted.PriceCheckResultLanguage contains the language for the PriceCheckResult.PriceCheckResultNote contains additional information in, free form text, pertinent to the PriceCheckResult.ResultListOfAttachment contains details of the attachments for the PriceCheckResult.Content: QuotedItem , ResultPrice (Type: Price) , PriceErrorInfo (Type: ErrorInfo)? , GeneralLineItemNote (Type: string)? , LineItemAttachment (Type: ListOfAttachment)?
Description: The PriceCheckResultItemDetail element contains the item detail information for the PriceCheckResult .
QuotedItem is a container for holding the original item detail from the PriceCheckRequest.ResultPrice is the unit price for the product when purchased in a particular quantity during a particular time period.PriceErrorInfo is optional error info related to price.GeneralLineItemNote describes any free-form text pertinent to the line item described by the PriceCheckResultDetail. 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.LineItemAttachment contains details of the attachments for the line item.Content: PriceCheckResultItemDetail+
Description: The ListOfPriceCheckResultItemDetail element contains a list of line items for the PriceCheckResult.
PriceCheckResultItemDetail contains the item detail information for the PriceCheckResult .Content: ListOfPrice , Tax* , ItemAllowancesOrCharges (Type: ListOfAllowOrCharge)? , TotalValue (Type: MonetaryValue)?
Description: The PricingDetail element contains all pricing information, including taxes, allowances and charges, and total price for an item.
ListOfPrice contains one or more pricing schemes for an item.Tax contains tax information as it relates to the pricing of an item.ItemAllowancesOrCharges contains the allowances and/or charges that apply to the pricing of an item.TotalValue identifies the monetary total for pricing of an item.Extends: Identifier
Description: The PrimaryID element contains a unique TradingPartnerID created by the marketplace. This ID is globally unique.
ShortID is an identifier that is unique to the marketplace.PrimaryIDURN is a uri that is used as a unique identifier.Content: MessageResponseIdentifier (Type: Reference) , PrimaryReturnCoded (Type: PrimaryReturnCode) , PrimaryReturnCodeDescription (Type: string)?
Description: The PrimaryMessageInformation element holds information on what happened to the actual initial document. Details will be in SecondaryMessageInformation.
MessageResponseIdentifier identifies the message response.PrimaryReturnCoded contains the coded information on the status of the request.PrimaryReturnCodeDescription contains a description for the above received return code.Description:
This code identifies if the initial request succeeded or not.
Value: Enumeration, including:
Content: Action? , ProductID , ProductIDExtension (Type: string)? , ProductIDStandard? , ProductName* , UOM? , Manufacturer? , ManuPartNumber (Type: string)? , LeadTime (Type: string)? , LeadTimeUOM (Type: UOM)? , ValidFrom (Type: date)? , ValidUntil (Type: date)? , CountryOfOrigin (Type: Country)? , MinOrder (Type: int)? , LotSize (Type: int)? , ExternalCategory (Type: string)* , ShortDescription* , LongDescription* , CatalogContract* , ProductPrice* , ProductVendorData* , ProductAttachment* , RelatedProduct* , ObjectAttribute*
Attribute: Name: Type - Data Type: ProductTypeCoded - Default Value: "Good"Description: The Product element contains all attributes associated with a product.
Action describes the action to be taken by an application processing the catalog, for the specific product.ProductID uniquely identifies the product.ProductIDExtension acts as an auxiliary of ProductID, providing further distinctions between items that have the same value for ProductID.ProductIDStandard indicates the agency whose product identification scheme is being used in ProductID.ProductName contains the name of the product. 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.".UOM Represents base unit of measure of the product, expressed as an ISO unit of measure code.Manufacturer supplies the name of the manufacturer or a reference to a manufacturer partner in the ListOfPartners. If a value is supplied in the PartnerRef attribute, the string content of the element will typically be ignored by the application or treated as secondary.ManuPartNumber holds the manufacturer's part number.LeadTime provides the lead time required when ordering the product described. Time is expressed in number of days unless otherwise specified in LeadTimeUOM.LeadTimeUOM supplies the time unit of measure for the product's lead time.ValidFrom gives an inclusive date that the product and its price begin to be available/applicable.ValidUntil gives the date on which the product and its price are no longer applicable.CountryOfOrigin holds an ISO Country Code indicating the country in which the goods described originated. This is typically important in a consideration of purchasing goods from overseas, because of import/export laws, etc.MinOrder Indicates the minimum order, in multiples of the unit supplied in the UOM element.LotSize Indicates the granularity possible with orders. It should be an integer, expressing multiples of the unit contained in the UOM element. The LotSize can change the effective minimum order from what is supplied in the MinOrder element. For example, if the LotSize is 3 and MinOrder is 5, customers in effect have to order at least 6 of the item.ExternalCategory gives a category name or classification code based on taxonomy other than the SchemaCategory pointed to by SchemaCategoryRef. Refers to a SchemaCategory present in the document pointed to by the SchemaSource of the CatalogSchema element. Use of ExternalCategory and SchemaSource is valuable when supplying catalogs with product instance data that needs to be validated against someone else's (such as an exchange's) schema.ShortDescription is a short description of the product. 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 is a long description of the product. 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.".CatalogContract contains information to identify the buyer's or supplier's contract, and the item identification in terms of that contract.ProductPrice gives a set of price information for the item. If there is more than one relevant price, repeat the element in the Productinstance.ProductVendorData holds the data specific to a particular product vendor. The product vendor is identified using the PartRef attribute.ProductAttachment allows the catalog creator to attach files of any type to the product description, and contains relevant information.RelatedProduct holds a reference to another product, using its product identifier, to establish a relationship between them, and to indicate the type of relationship.ObjectAttribute Other aspects of the overall catalog or catalog administration or product description that are not in elements that already exist in the CatalogHeader or Product.Type This attribute provides a distinction between goods and services as these are described in the Product element.SchemaCategoryRef is a link (an XML IDREF) to a SchemaCategory in the CatalogSchema. Since the link is an XML IDREF, the SchemaCategoryRef attribute will only work if a schema has been supplied with this document.Content: EMPTY
Attribute: Name: Value - Data Type: ActionValueCode - Default Value: "Add"Description: The Action element specifies the action to be taken by the application processing the product description.
Value indicates the action to be taken: Add, Update, or Delete. When no Action is present a default is assumed of either Add or Update depending on the other flags present on the CatalogHeader.Description:
This code identifies the action taken by the application processing the data.
Value: Enumeration, including:
Description: The ProductID element uniquely identifies the product.
Type indicates whether the ProductID was created by a buyer, a supplier or "other" (such as a marketplace).Description: The ProductIDStandard element indicates the agency whose product identification scheme is being used in ProductID.
Agency identifies the organization and if necessary the codelist from which the identifier is assigned.Description: The ProductName element contains the name of the product. Multilanguage support is provided by potentially having multiple ProductName 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.Description: The Manufacturer element supplies the name of the manufacturer or a reference to a manufacturer partner in the ListOfPartners. If a value is supplied in the PartnerRef attribute, the string content of the element will typically be ignored by the application or treated as secondary.
PartnerRef provides an XML ID value corresponding to the ID supplied for a manufacturer described in the ListOfPartners element.Description: The RelatedProduct element allows the catalog to describe relationships between products, both by identifying the related product, and by explaining what type of relationship is being indicated. The content of this element should be the product ID of the related product.
TargetType holds a code to identify the type of target.Description:
This code identifies the type of product
Value: Enumeration, including:
Description:
This code identifies the standard that the product ID is produced to.
Value: Enumeration, including:
Description:
This code identifies the type of target or related product within the ProductCatalog document
Value: Enumeration, including:
Content: UOMCoded (Type: UOMCode) , UOMCodedOther (Type: string)?
Description: The UOM element represents the base unit of measure.
UOMCoded is used to define the unit of measure.UOMCodedOther is used to specify the non-standard code indicated by the use of 'Other' in UOMCoded.Content: AttachmentURL (Type: URI) , AttachmentPurpose (Type: string)? , AttachmentMIMEType (Type: string)? , ShortDescription* , LongDescription*
Description: The ProductAttachment element allows the catalog creator to attach files of any type to the product description, and contains relevant information.
AttachmentURL gives the URL of the attached file, used by the processing application to retrieve the attachment.AttachmentPurpose indicates the purpose of the attached file. This is not a coded value, and so will generally be displayed by the processing application for the edification of the user.AttachmentMIMEType supplies the MIME type of the attached file, to enable the processing application to display the correct behavior based on the type of the file.ShortDescription gives a single short description of the attachment. This takes an xml:lang attribute, which must contain a valid code according to RFC 1766. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English.".LongDescription is a long description of the attachment. 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.".Content: CatalogHeader , CatalogSchema? , CatalogData?
Description: The ProductCatalog element is a document that is used to supply pricing and product description data to trading partners. It is also used to configure non-standard product attributes that are useful for a particular type of product, service, catalog, etc., and is sometimes used as a vehicle for exchanging non-standard attributes and categorizations.
CatalogHeader contains administrative information about the catalog including its provider, and suppliers and other trading partners present in the catalog.CatalogSchema provides optional information about the structure of products in the catalog.CatalogData is a container for instances of products described in the ProductCatalog.Description:
This code shows the qualifier used to identify the product.
Value: Enumeration, including:
Content: Amount (Type: Decimal18_3) , PriceType (Type: string)? , Currency? , UOM? , MinimumQuantity (Type: int)? , ShortDescription? , ValidFrom (Type: date)? , ValidUntil (Type: date)? , Buyer? , PriceBasisQuant (Type: number)?
Description: The ProductPrice element gives a set of price information for the item. If there is more than one relevant price, repeat the element.
Amount supplies the price of the item as a decimal currency amount.PriceType gives the type of price being supplied, based on the catalog creator's or agreed-upon distinctions.Currency supplies an ISO Currency Code that overrides the default currency for the catalog if supplied.UOM gives an ISO unit of measure code that is the basis for pricing.MinimumQuantity supplies the minimum order quantity at the specified price.ShortDescription gives a single short description of the price. This takes an xml:lang attribute, which must contain a valid code according to RFC 1766. If not specified in DefaultLanguage or in a specific element, the value is assumed to be en for "English.".ValidFrom gives an inclusive date on which the price becomes applicable.ValidUntil gives the date on which the price ceases to be applicable.Buyer provides the name of a buyer, or a reference to a buyer described in ListOfTradingPartner. If the name is supplied, as well as a reference to the buyer, the reference should be treated as the primary identifier.PriceBasisQuant holds the quantity that is the basis of the price. For example, if the price is $10 for a five-pack, this value would be 5.Description: The Buyer element provides the name of a buyer, or a reference to a buyer described in ListOfTradingPartner. If the name is supplied, as well as a reference to the buyer, the reference should be treated as the primary identifier.
PartnerRef holds an XML IDREF value that matches one of the IDs associated with a buyer in the ListOfTradingPartner.Content: VendorPartNumber (Type: string)? , LeadTime (Type: string)? , LeadTimeUOM (Type: UOM)? , CatalogContract? , MinOrder (Type: int)? , ProductPrice*
Attribute: Name: PartnerRef - Data Type: IDREF - Default Value: #REQUIREDDescription: The ProductVendorData element holds the data specific to a particular product vendor. The product vendor is identified using the PartRef attribute.
VendorPartNumber contains the vendor's part number.LeadTime provides the lead time required when ordering the product described, from the particular vendor. Time is expressed in number of days unless otherwise specified in LeadTimeUOM.LeadTimeUOM supplies the time unit of measure for the product's lead time.CatalogContract holds the contract information specific to the vendor identified in PartnerRef.MinOrder gives the minimum order for the specified vendor, expressed in terms of the product's UOM.ProductPrice supplies the price for the specified vendor.PartnerRef identifies the product vendor, by referring to the ListOfPartner construction. This element holds an XML IDREF value that corresponds to the XML ID supplied to identify the vendor on that list.Content: PurchaseOrderNumber (Type: Reference) , PurchaseOrderDate (Type: datetime)? , PurchaseOrderLineItemNumber (Type: string)? , PartialOrderCoded (Type: ASNPartialOrderCode)? , PartialOrderCodedOther (Type: string)?
Description: The PurchaseOrderReference element contains information relevant to the purchase order the invoice is issued against.
PurchaseOrderNumber holds the identifying reference for the purchase order.PurchaseOrderDate holds the date of issue of the purchase order.PurchaseOrderLineItemNumber holds the line item number of the referenced purchase order.PartialOrderCoded is a code specifying the status of the order.PartialOrderCodedOther is used to provide a non-standard ASNPartialOrderCode. This element is mandatory if the value of PartialOrderCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: PurposeCoded (Type: PurposeCode) , PurposeCodedOther (Type: string)?
Description: The Purpose element is used to communicate the function of a document.
PurposeCoded defines the function of the document using a standard codelist.PurposeCodedOther is used to provide a non-standard PurposeCode. This element is mandatory if the value of PurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This identifies the function of a document. This code list is derived from EDIFACT 1225 (Message function, coded) and X12 353 (Transaction Set Purpose Code).
Value: Enumeration, including:
Content: (QuantityValue | QuantityRange) , UnitOfMeasurement
Description: The Quantity element identifies a quantitative amount of an item.
QuantityValue is used to specify a specific value of a quantity.QuantityRange is used to specify a range for a quantity.UnitOfMeasurement specifies the unit of measurement that the value or the range is specified in.Content: number
Attribute: Name: SignificanceCoded - Data Type: SignificanceCode - Default Value: #IMPLIEDDescription: The QuantityValue element is used to specify a specific value of a quantity.
SignificanceCoded describes the significance of the a quantity using a standard codelist.SignificanceCodedOther is used to provide a non-standard SignificanceCode. This element is mandatory if the value of SignificanceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ConditionsCoded describes the conditions that apply to the quantity.ConditionsCodedOther is used to provide a non-standard ConditionsCode. This element is mandatory if the value of ConditionsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: MinimumValue , MaximumValue
Description: The QuantityRange element is used to specify a range for a quantity.
MinimumValue specifies the minimum quantity in a range.MaximumValue specifies the maximum quantity in a range.Extends: Quantity
Description: The QuantityCoded element contains a quantity not explicitly stated in another element.
QuantityQualifierCoded is the purpose of a quantity using a standard codelist.QuantityQualifierCodedOther is used to provide a non-standard QuantityQualifierCode. This element is mandatory if the value of QuantityQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Quantity+
Description: The ListOfQuantity element contains a list of one or more quantities.
Quantity is used to specify a specific value of a quantity. A container for a list of one or more Quantity elements.Content: QuantityCoded+
Description: The ListOfQuantityCoded element is a container holding a list of quantities not explicitly stated in other elements.
QuantityCoded contains a quantity not explicitly stated in another element.Description:
This code identifies the type of quantities. This code list is derived from EDIFACT 6063 (Quantity type code qualifier) and X12 673 (Quantity qualifier)
Value: Enumeration, including:
Content: QuotationReqReference (Type: Reference) , ReferenceReleaseNumber (Type: string)?
Description: The QuotationRequestReference element identifies the RequestReference.
QuotationReqReference contains the reference for the Request for which the Quote is placed against.ReferenceReleaseNumber identifies the specific iteration of the quotation (if applicable).Content: QuoteHeader , ListOfQuoteDetails? , ListOfQuotePackageDetail (Type: ListOfPackageDetail)? , QuoteSummary?
Description: The Quote element contains information in response to a RequestForQuotation. This will contain details on the availability of the goods and prices if applicable.
QuoteHeader holds the header-level information for the Quote.ListOfQuoteDetails contains the line level detail information for the Quote.ListOfQuotePackageDetail lists the packaging information for the Quote.QuoteSummary contains the summary information for the Quote.Content: TotalNumberOfLineItems (Type: int)?
Description: The QuoteSummary element contains details summarizing the quote.
TotalNumberOfLineItems contains the total number of line items for message.Content: QuoteDetails+
Description: The ListOfQuoteDetails element contains the line level detail information for the quote.
QuoteDetails contains the line item and package details of the Quote.Content: QuoteItemType (Type: QuoteType) , QuoteItemDetail , QuotePricingDetail (Type: PricingDetail)? , QuoteDeliveryDetail (Type: DeliveryDetail)? , QuoteItemListOfAttachment (Type: ListOfAttachment)?
Description: The QuoteDetails element contains detailed information concerning the quote.
QuoteItemType specifies the type of quote at item level.QuoteItemDetail identifies the material relevant information associated with the quote.QuotePricingDetail holds the pricing information for the line item.QuoteDeliveryDetail holds the delivery information for the line item- includes scheduling, transport, delivery terms and basic packaging information for the line item.QuoteItemListOfAttachment contains the attachments for the line item.Extends: BaseItemDetail
Description: The QuoteItemDetail element identifies the material relevant information associated with the quote.
QuoteItemReferences identifies the references at line item level.QuoteItemParty identifies the parties at line item level.Content: QuoteIssueDate (Type: datetime) , QuoteID (Type: Reference) , QuotationRequestReference? , QuoteType? , QuoteParty (Type: OrderParty) , QuoteTransport (Type: TransportRouting)? , QuoteCurrency (Type: Currency)? , QuoteAllowanceOrCharge (Type: ListOfAllowOrCharge)? , QuoteTermsOfPayment (Type: PaymentInstructions)? , QuoteTermsOfDelivery (Type: TermsOfDelivery)? , QuoteTax (Type: TaxReference)* , QuoteLanguage (Type: Language)? , GeneralNotes (Type: string)? , QuoteListOfAttachment (Type: ListOfAttachment)?
Description: The QuoteHeader element holds all RequestforQuotation header-level information. This element occurs once within the document.
QuoteIssueDate holds a time stamp provided by the application that created the Quote document.QuoteID is the unique number assigned to the Quote, typically according to the system that generated the Quote.QuotationRequestReference identifies the RequestReference sent in the RequestForQuotation.QuoteType specifies the type of Quote generated in response to the request.QuoteParty specifies the parties involved in the Quote.QuoteTransport specifies the transport for the Quote.QuoteCurrency specifies the currency to used for the Quote.QuoteAllowanceOrCharge lists the allowance and or charges for the Quote.QuoteTermsOfPayment describes the terms of payment for the Quote.QuoteTermsOfDelivery defines the terms of delivery for the Quote.QuoteTax provides the tax information for the Quote.QuoteLanguage identifies the language used on the Quote.GeneralNotes contains any free-form text pertinent to the entire consignment described by the Quote or to the 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 nominate another supplier if applicable.QuoteListOfAttachment lists the attachments for the quote.Content: QuoteTypeCoded (Type: QuoteTypeCode) , QuoteTypeCodedOther (Type: string)?
Description: The QuoteType element specifies the type of quote generated in response to the request.
QuoteTypeCoded lists the code values for the type of the Quote.QuoteTypeCodedOther is used to specify a non-standard QuoteTypeCode. The element is mandatory if the value of QuoteTypeCoded is "Other". These codes should not contain white spaces unless absolutely necessary.Description:
This code identifies the code values for the type of quote.
Value: Enumeration, including:
Content: CheckResultBaseItemDetail
Description: The QuotedItem element is a container for holding the original item detail from the PriceCheckRequest.
CheckResultBaseItemDetail contains the identifying and descriptive information for the line items in PriceCheckResult.Extends: BaseItemDetail
Description: The CheckResultBaseItemDetail element contains the identifying and descriptive information for the line items in PriceCheckRequest.
CheckResultTransport contains transport information for the line item.Content: MinimumValue , MaximumValue
Description: The Range element identifies a range of values by a minimum and maximum value.
MinimumValue holds the minimum value of the range and its inclusiveness.MaximumValue holds the maximum value of the range and its inclusiveness.Content: number
Attribute: Name: SignificanceCoded - Data Type: SignificanceCode - Default Value: #IMPLIEDDescription: The MinimumValue element specifies the minimum value and its inclusiveness. This is a string content model of a number datatype.
SignificanceCoded describes the inclusiveness of the minimum value using a standard codelist.SignificanceCodedOther is used to provide a non-standard SignificanceCode. This element is mandatory if the value of SignificanceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ConditionsCoded describes the conditions that apply to the minimum value.ConditionsCodedOther is used to provide a non-standard ConditionsCode. This element is mandatory if the value of ConditionsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: number
Attribute: Name: SignificanceCoded - Data Type: SignificanceCode - Default Value: #IMPLIEDDescription: The MaximumValue element specifies the maximum value and its inclusiveness. This is a string content model of a number datatype.
SignificanceCoded describes the inclusiveness of the maximum value using a standard codelist.SignificanceCodedOther is used to provide a non-standard SignificanceCode. This element is mandatory if the value of SignificanceCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ConditionsCoded describes the conditions that apply to the maximum value.ConditionsCodedOther is used to provide a non-standard ConditionsCode. This element is mandatory if the value of ConditionsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: ReferenceCurrency (Type: Currency) , TargetCurrency (Type: Currency) , RateOfExchange (Type: Decimal19_9) , InverseRateOfExchange (Type: Decimal19_9)? , DateOfRateOfExchange (Type: datetime)? , ListOfRateOfExchangeReference (Type: ListOfReference)?
Description: The RateOfExchangeDetail element contains the detail of the exchange rate between two currencies.
ReferenceCurrency holds the reference currency of the rate of exchange. This is the currency from which the monetary value is to be converted from.TargetCurrency is the target currency of the rate of exchange. This is the currency from which the monetary value is to be converted to.RateOfExchange holds the value that the reference currency is to be multiplied by to convert it to the target currency.InverseRateOfExchange contains the rate of exchange given as target currency : reference currency.DateOfRateOfExchange holds the date the rate of exchange was quoted.ListOfRateOfExchangeReference holds a reference to identify rate of exchange request.Content: RateOfExchangeDetail+
Description: The ListOfRateOfExchangeDetail element contains one or more elements detailing information on the rate of exchange between currencies.
RateOfExchangeDetail holds information on the rate of exchange between two currencies.Description:
This code identifies the reason for exemption from tax. This code list is derived from X12 441 (Tax exempt code)
Value: Enumeration, including:
Content: RefNum (Type: string) , RefDate (Type: datetime)?
Description: The Reference element contains information that can be used to find further information elsewhere.
RefNum is the reference characters which distinguish the source of information.RefDate holds the date of the reference information.Content: ReferenceTypeCoded (Type: ReferenceTypeCode) , ReferenceTypeCodedOther (Type: string)? , PrimaryReference (Type: Reference) , SupportingReference (Type: Reference)? , SupportingSubReference (Type: Reference)? , ReferenceDescription (Type: string)?
Description: The ReferenceCoded element identifies the source of the information using a standard codelist.
ReferenceTypeCoded is used to identify the type of source of information by using a standard codelist.ReferenceTypeCodedOther is used to provide a non-standard ReferenceTypeCode. This element is mandatory if the value of ReferenceTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.PrimaryReference holds the highest level of identification of the information source. This is typically used to identify a document.SupportingReference holds the second level of identification of the information source. This is typically used to identify a line item in the document being referenced.SupportingSubReference holds the lowest level of identification of the information source. This is typically used reference a sub line item in a document.ReferenceDescription is used to describe a reference using free form text.Content: Reference+
Description: The ListOfReference element contains one or more elements containing information that can be used to find further information elsewhere.
Reference contains information that can be used to find further information elsewhere.Content: ReferenceCoded+
Description: The ListOfReferenceCoded element contains one or more elements containing information that can be used to find further information elsewhere that are not explicitly stated in another element.
ReferenceCoded identifies the source of the information using a standard codelist.Description:
This code identifies the meaning to a reference. This code list is derived from EDIFACT 1153 (Reference function code qualifier) and X12 128 (Reference identification qualifier)
Value: Enumeration, including:
Content: RegionCoded (Type: RegionCode) , RegionCodedOther (Type: string)?
Description: The Region element identifies a region within a country.
RegionCoded identifies the region within a country using a standard code list.RegionCodedOther is used to provide a non-standard RegionCode. This element is mandatory if the value of RegionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: Region+
Description: The ListOfRegion element holds the information regarding regions within countries.
Region holds the basic list of regions within a country.Description:
This code identifies the region within a country. This code list is derived from ISO 3166/1998 (Country code subdivision code, UN/LOCODE 2000)
Value: Enumeration, including:
Content: RelatedInvoiceType (Type: InvoiceType) , InvoiceNumber (Type: Reference) , InvoiceLineItemNumber (Type: string)?
Description: The RelatedInvoiceRef element holds a reference to another invoice.
RelatedInvoiceType identifies the type of the invoice that is being referenced.InvoiceNumber holds the number of another invoice issued by the seller.InvoiceLineItemNumber holds a reference to the line item within the referenced invoice.Content: RelatedInvoiceRef+
Description: The ListOfRelatedInvoiceRef element contains a list of other invoices related to this invoice or InvoiceDetail.
RelatedInvoiceRef holds a reference to another invoice.Content: RemittanceAdviceHeader , ListOfRemittanceAdviceDetail , RemittanceAdviceSummary (Type: PaymentRequestSummary)
Description: The RemittanceAdvice element advises a trading partner of payment for specific goods and/or services being provided. Payers may initiate a RemittanceAdvice with a related payment request to specify the exact goods being paid. Payers may also initiate a RemittanceAdvice to inform payees of the intent to refund moneys for specific goods and/or services.
RemittanceAdviceHeader contains the header information for the RemittanceAdvice.ListOfRemittanceAdviceDetail contains all line item information pertaining to the RemittanceAdvice.RemittanceAdviceSummary contains summary information for the RemittanceAdvice document.Content: (ListOfSubsidiary | ListOfInvoicingDetail | ListOfAdjustments) , GeneralNote (Type: string)?
Description: The RemittanceAdviceDetail element contains detail information pertaining to the RemittanceAdvice document. The structure is composed of Adjustments, Subsidiary and/or InvoicingDetail.
(Adjustments+ | Subsidiary | InvoicingDetail+)
Users can specify adjustment information only in the case where the remittance detail is for payment of a single invoice. The adjustment structure contains details of the line item, adjustment amounts, and adjustment reasons.
A subsidiary can be specified in the case where the invoicing is performed by a central/parent company. Each subsidiary contains invoicing document information that details out the goods/services that were issued.
An invoicing document contains invoicing information at the line item level.
ListOfSubsidiary contains a set of subsidiary detail with associated invoicing and adjustment information. This structure is used in the case where the payment is made by a central party and invoice detail needs to be specified by subsidiary.ListOfInvoicingDetail contains a set of invoicing detail.ListOfAdjustments contains a set of adjustment detail.GeneralNote describes any free-form text pertinent to the detail item described by the RemittanceAdvice. 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: RemittanceAdviceDetail+
Description: The ListOfRemittanceAdviceDetail element contains all detail information pertaining to the RemittanceAdvice.
RemittanceAdviceDetail contains detail information pertaining to the RemittanceAdvice document. The structure is composed of Adjustments, Subsidiary and/or InvoicingDetail.(Adjustments+ | Subsidiary | InvoicingDetail+)
Users can specify adjustment information only in the case where the remittance detail is for payment of a single invoice. The adjustment structure contains details of the line item, adjustment amounts, and adjustment reasons.
A subsidiary can be specified in the case where the invoicing is performed by a central/parent company. Each subsidiary contains invoicing document information that details out the goods/services that were issued.
An invoicing document contains invoicing information at the line item level.
Content: RemittanceAdvicePurpose (Type: Purpose) , RemittaceAdviceIssueDate (Type: datetime) , RemittanceAdviceID (Type: Reference) , PaymentSettlementDate (Type: datetime)? , TotalAmountDue (Type: MonetaryValue)? , TotalAmountPaid (Type: MonetaryValue) , PaymentCurrency (Type: Currency) , ListOfRateOfExchangeDetail? , Language , IsCredit (Type: boolean)? , PaymentInstructions? , PaymentParty , PaymentReasonCoded (Type: PaymentReasonCode)? , PaymentReasonCodedOther (Type: string)? , ListOfRemittanceAdviceReference (Type: ListOfReferenceCoded)? , RemittanceAdviceAttachment (Type: Attachment)? , GeneralNote (Type: string)?
Description: The RemittanceAdviceHeader element contains the header information for the RemittanceAdvice.
RemittanceAdvicePurpose indicates the intended use of the RemittanceAdvice document.RemittaceAdviceIssueDate holds a time stamp provided by the application that created the RemittanceAdvice document.RemittanceAdviceID contains the unique number that identifies the RemittanceAdvice, typically according to the system that generated the RemittanceAdvice.PaymentSettlementDate contains the date the originating company intends for the transaction to be settled.TotalAmountDue contains the total amount of payment due.TotalAmountPaid contains the total amount of payment being made.PaymentCurrency specifies the currency used in the payment transaction.ListOfRateOfExchangeDetail contains one or more elements detailing information on the rate of exchange between currencies.Language specifies the language used in the RemittanceAdvice. This is an ISO language code.IsCredit contains a boolean indicator to specify whether the amount is a credit or debit.PaymentInstructions contains the terms and the method of payment for goods or services received.PaymentParty contains information on all parties involved in the RemittanceAdvice.PaymentReasonCoded specifies the business purpose of the payment.PaymentReasonCodedOther is used to provide a non-standard PaymentReasonCode. This element is mandatory if the value of PaymentReasonCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfRemittanceAdviceReference contains a list of documents, business transactions, or identifiers that are relevant to the RemittanceAdvice document, i.e.: invoices, purchase order, ASN.RemittanceAdviceAttachment contains an attachment applicable to the entire RemittanceAdvice. The information is not specific to a particular line item or document, unless specifically noted.GeneralNote contains any free-form text pertinent to the entire RemittanceAdvice. 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: RequestQuoteHeader , ListOfRequestQuoteDetails? , ListOfRequestQuotePackageDetail (Type: ListOfPackageDetail)? , RequestQuoteSummary?
Description: The RequestForQuotation element consists of the request for a quotation to be sent from the buyer to the supplier. The document outlines the requirements regarding the details for a request for quotation sent directly between the two parties. The request can be used to request goods or services. The requests are based on the terms and conditions defined either in a previous purchasing agreement or in the request itself. The request can be used to determine the availability of goods from existing suppliers where price will not be a deciding factor. The RequestForQuotation defined here allows for delivery information to be built into the request. All schedule requirements relating to shipping and release authorization will be handled by the ShippingSchedule document. The response to the request (a quote) can be used as the basis for a purchase order by the buyer if appropriate.
RequestQuoteHeader holds all RequestForQuotation header-level information.ListOfRequestQuoteDetails contains the line level detail information for the RequestForQuotation.ListOfRequestQuotePackageDetail lists the packaging information.RequestQuoteSummary contains details summarizing the RequestForQuotation.Content: TotalNumberOfLineItems (Type: int)?
Description: The RequestQuoteSummary element contains details summarizing the RequestForQuotation.
TotalNumberOfLineItems Total number of line items for message.Content: RequestQuoteValidityDate (Type: ValidityDates) , DecisionDate (Type: datetime)? , DeliveryDate (Type: datetime)? , DeliveryDateEarliest (Type: datetime)? , DeliveryDateLatest (Type: datetime)? , AdviseBefore (Type: datetime)? , CancelIfNotDelivered (Type: datetime)?
Description: The RequestQuoteDate element holds the dates for the RequestforQuotation.
RequestQuoteValidityDate holds horizon start and end dates to indicate the validity period of the Request.DecisionDate indicates the date by when a decision will be made. This is always later than the end date.DeliveryDate specifies the delivery date for the goods.DeliveryDateEarliest specifies the earliest delivery date.DeliveryDateLatest specifies the latest delivery date.AdviseBefore specifies the date that you must advise before.CancelIfNotDelivered specifies the date that the goods must be delivered by or the order will be cancelled.Content: RequestQuoteDetails+
Description: The ListOfRequestQuoteDetails element contains the line level detail information for the RequestForQuotation.
RequestQuoteDetails contains the line item level information for the RequestForQuotation.Content: RequestQuoteItemDetail (Type: BaseItemDetail) , RequestQuotePricingDetail (Type: PricingDetail)? , RequestQuoteDeliveryDetail (Type: DeliveryDetail)? , RequestQuoteItemListOfAttachment (Type: ListOfAttachment)?
Description: The RequestQuoteDetails element contains the line item level information for the RequestForQuotation.
RequestQuoteItemDetail identifies the material relevant information associated with the RequestForQuotation.RequestQuotePricingDetail identifies details of the pricing associated with the line item.RequestQuoteDeliveryDetail specifies delivery information for the line item including scheduling, transport, delivery terms and basic packaging information for the line item.RequestQuoteItemListOfAttachment contains attachments for the line item.Content: RequestQuoteIssueDate (Type: datetime) , RequestQuoteID (Type: Reference) , RequestQuoteReference? , RequestQuotePurpose? , RequestQuoteDate? , RequestQuoteParty (Type: OrderParty) , ResultingOrderType (Type: OrderType)? , RequestQuoteCurrency (Type: Currency)? , RequestQuoteAllowanceOrCharge (Type: ListOfAllowOrCharge)? , RequestQuoteTermsOfPayment (Type: PaymentInstructions)? , RequestQuoteTermsOfDelivery (Type: TermsOfDelivery)? , RequestQuoteTax (Type: Tax)? , RequestQuoteTransport (Type: TransportRouting)? , RequestQuoteLanguage (Type: Language)? , RequestQuoteGeneralNotes (Type: string)? , RequestQuoteListOfAttachment (Type: ListOfAttachment)?
Description: The RequestQuoteHeader element holds all RequestForQuotation header-level information.
RequestQuoteIssueDate indicates the date the request is created in the application.RequestQuoteID contains a reference number to identify the request document.RequestQuoteReference contains a list of references for the request.RequestQuotePurpose indicates the use of the document.RequestQuoteDate holds the dates for the RequestforQuotation.RequestQuoteParty identifies the parties involved in the quotation.ResultingOrderType identifies the type of the resulting order.RequestQuoteCurrency identifies the currency to quote in.RequestQuoteAllowanceOrCharge lists the allowances and or charges for the request.RequestQuoteTermsOfPayment describes the terms of payment relevant to the request.RequestQuoteTermsOfDelivery defines the terms of delivery for the request.RequestQuoteTax identifies the relevant tax information.RequestQuoteTransport describes the transport information for the message.RequestQuoteLanguage describes the language used on the RequestForQuotation.RequestQuoteGeneralNotes contains general instructions for the RequestForQuotation. This can be used to nominate another supplier if applicable.RequestQuoteListOfAttachment holds the list of attachments for the request.Content: RequestQuotePurposeCoded (Type: RequestQuotePurposeCode) , RequestQuotePurposeCodedOther (Type: string)?
Description: The RequestQuotePurpose element indicates the use of the document.
RequestQuotePurposeCoded indicates the intended use of the RequestforQuotation.RequestQuotePurposeCodedOther is used to provide a non-standard RequestQuotePurposeCode. This element is mandatory if the value of RequestQuotePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the purpose of the RequestforQuotation message. This is a subset code list derived from EDIFACT 1225 (Message function, coded) and X12 353 (Transaction set purpose code) and 587 (Acknowledgement type code)
Value: Enumeration, including:
Content: ContractReference (Type: Contract)? , AccountNumber (Type: Reference)? , PriceListNumber (Type: Reference)? , PriceListVersionNumber (Type: Reference)? , BuyersCatalogNumber (Type: Reference)? , OtherRequestQuoteReferences (Type: ListOfReferenceCoded)?
Description: The RequestQuoteReference element contains a list of references for the request.
ContractReference identifies the contract number which the request is referencing.AccountNumber contains the buyers account code with the supplier.PriceListNumber identifies the reference number of the price list.PriceListVersionNumber identifies the version number of the price list.BuyersCatalogNumber identifies the catalog number of the buyer.OtherRequestQuoteReferences lists any other references to the Request not documented by the ContractReference.Content: RequestedResponseCoded (Type: RequestedResponseCode) , RequestedResponseCodedOther (Type: string)?
Description: The RequestedResponse element specifies the type of acknowledgment requested by the buyer from the seller.
RequestedResponseCoded is the code value of the requested acknowledgment.RequestedResponseCodedOther is used to provide a non-standard RequestedResponseCode. This element is mandatory if the value of RequestedResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of response requested. 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 587 (Acknowledgment type)
Value: Enumeration, including:
Content: ResponseTypeCoded (Type: ResponseTypeCode) , ResponseTypeCodedOther (Type: string)?
Description: The ResponseType element defines the type of response sent between seller and buyer.
ResponseTypeCoded specifies the type of acknowledgment sent by the seller to the buyer in response to an Order or ChangeOrder document.ResponseTypeCodedOther is used to provide a non-standard ResponseTypeCode. This element is mandatory if the value of ResponseTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the type of acknowledgment sent by the buyer or seller. 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:
Description:
This code indicates the contents or state of goods on a returnable container. This code list is derived from EDIFACT 8393 (Returnable package load contents coded) and X12 728 (Returnable container load make-up code)
Value: Enumeration, including:
Content: ReturnableContainerPartNumber (Type: PartNum)? , PaymentResponsibilityCoded (Type: PaymentResponsibilityCode)? , PaymentResponsibilityCodedOther (Type: string)? , ReturnLoadCoded (Type: ReturnLoadCode)? , ReturnLoadCodedOther (Type: string)? , ReturnNote (Type: string)?
Description: The ReturnableContainerInfo element describes shipping, payment and miscellaneous information regarding containers that are returned after they have been used in shipment.
ReturnableContainerPartNumber is the part number of the returnable container.PaymentResponsibilityCoded designates which party is responsible for payment of the returnable containers.PaymentResponsibilityCodedOther is used to provide a non-standard PaymentResponsibilityCode. This element is mandatory if the value of PaymentResponsibilityCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ReturnLoadCoded describes the contents or state of contents of the returnable container.ReturnLoadCodedOther is used to provide a non-standard ReturnLoadCode. This element is mandatory if the value of ReturnLoadCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ReturnNote text notes and instructions relating to the returnable container.Content: TradingPartnerPrimaryID (Type: PrimaryID)? , AlternateID (Type: string)? , UserID? , ReturnedIdentificationURN (Type: URI)?
Description: The ReturnedIdentification element contains the information on returned identification.
TradingPartnerPrimaryID is the primary ID of the organization involved in this response.AlternateID is the alternative ID of the organization in this response.UserID is the user ID involved in this response.ReturnedIdentificationURN is the URL to the full error info of any problem that occurred.Content: ReturnedIdentification+
Description: The ListOfReturnedIdentification element holds information on IDs which have been created or changed.
ReturnedIdentification contains the information on returned identification.Content: RuleName (Type: string) , RuleDescription (Type: string)? , RuleValue (Type: string) , RuleFormula (Type: string)?
Description: The Rule element contains specific information to describe a custom rule in the auction.
RuleName contains the name of the rule.RuleDescription contains a description of the rule.RuleValue contains the rule value.RuleFormula contains a user defined formula to determine the terms of the auction with respect to the described rule.Content: Rule+
Description: The ListOfRules element describes a set of generic rules associated with the auction.
Rule contains specific information to describe a custom rule in the auction.Content: BidRuleCoded (Type: BidRuleCode) , BidRuleCodedOther (Type: string)? , MVBTemplate (Type: string)? , WinRuleCoded (Type: WinRuleCode) , WinRuleCodedOther (Type: string)? , VisibilityRules? , ListOfRules?
Description: The RulesProfile element contains all the rules associated with the auction.
BidRuleCoded describes the bidding requirements for the auction.BidRuleCodedOther is non-standard or user defined bid rule code.MVBTemplate is required when MVBForward or MVBReverse is chosen as the BidRule. The template must exist in Auction Services. The originator of the auction needs to set this up with Auction Services prior to sending the AuctionCreate document.WinRuleCoded indicates how the winner of the auction is determined.WinRuleCodedOther is non-standard or user defined win rule code.VisibilityRules indicates the visibility level of the auction. If the information is not provided, then the assumption is made that the auction is public and that all values are visible.ListOfRules describes a set of generic rules associated with the auction.Content: SalesRequirementCoded (Type: SalesRequirementCode) , SalesRequirementCodedOther (Type: string)?
Description: The SalesRequirement element outlines any specific sales information relating to the item.
SalesRequirementCoded identifies a specific requirement or agreement of sale.SalesRequirementCodedOther is used to provide a non-standard SalesRequirementCode. This element is mandatory if the value of SalesRequirementCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies a specific requirement or agreement of sale. This code list is derived from X12 563 (Sales requirement code)
Value: Enumeration, including:
Content: CommitmentLevelCoded (Type: CommitmentLevelCode) , CommitmentLevelCodedOther (Type: string)? , ScheduleDates (Type: ListOfDateCoded) , ScheduleQuantities (Type: ListOfQuantityCoded) , ItemResourceAuthorization? , ScheduleNote (Type: string)?
Description: The ScheduleDetail element provides the commitment level, dates, and quantity for the shipment.
CommitmentLevelCoded identifies the commitment level for the forecast.CommitmentLevelCodedOther is used to provide a non-standard CommitmentLevelCode. This element is mandatory if the value of CommitmentLevelCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ScheduleDates is a list of forecasted dates and times corresponding to the commitment level for the given material and location.ScheduleQuantities is the quantity of the line item for the scheduled date.ItemResourceAuthorization is used to specify resource authorization in the schedule.ScheduleNote contains any free-form text pertinent to the PlanningSchedule. 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: ScheduleDetail+
Description: The ListOfScheduleDetail element is the detailed schedule information for the materials. Includes dates and quantity.
ScheduleDetail provides the commitment level, dates, and quantity for the shipment.Content: ScheduleLineID (Type: int)? , Quantity , RequestedDeliveryDate (Type: datetime)? , ListOfOtherDeliveryDate (Type: ListOfDateCoded)? , (Transport | TransportReference (Type: int))? , ListOfShipToSubInformation?
Description: The ScheduleLine element contains the information on a portion of the line item shipment to be sent on particular set of dates with a particular set of transport information.
ScheduleLineID uniquely identifies the schedule line within the line item. This is used for external reference.Quantity contains the sub-quantity to be shipped on a particular set of dates.RequestedDeliveryDate is the date the buyer requested for delivery.ListOfOtherDeliveryDate lists the dates revolving around delivery.This is used to express simple date information that is not tied to particular carriers, transport, etc. When non-detailed schedule information is required use SimpleScheduleDetail.Transport contains carrier, equipment, and mode of transport information.TransportReference references the transport routing element to identify which transport legs the package is travelling on. This element is repeated if the package travels on more than one transport route.ListOfShipToSubInformation details place and quantity information regarding the shipto sub-location.Content: ScheduleLine+
Description: The ListOfScheduleLine element 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.
ScheduleLine contains the information on a portion of the line item shipment to be sent on particular set of dates with a particular set of transport information.Content: BuyerParty (Type: Party) , SellerParty (Type: Party) , ShipFromParty (Type: Party) , ShipToParty (Type: Party) , BillToParty (Type: Party)? , MaterialIssuerParty (Type: Party)? , ListOfPartyCoded?
Description: The ScheduleParty element contains information on the parties to the PlanningSchedule, including unique ID's and address information.
BuyerParty is the buyer of the goods or services.SellerParty is the seller of the goods or services.ShipFromParty is the party that is planning the good or services.ShipToParty is the party that is receiving the goods or services.BillToParty is the party that is responsible for payment of the goods or services.MaterialIssuerParty is the party issuing the material release on behalf of the ship-to destination.ListOfPartyCoded contains information relevant to describing parties other than the source target parties which are relevant to the time series data.Content: ContractReferences (Type: ListOfContract)? , ScheduleOrderReference? , OrderType? , OtherScheduleReferences (Type: ListOfReferenceCoded)?
Description: The ScheduleReferences element is used to identify references to other documents and release information for the PlanningSchedule.
ContractReferences is an element that holds the contract number and contract type for referencing a contract.ScheduleOrderReference references the PurchaseOrder that the PlanningSchedule references.OrderType identifies the type of order being referenced.OtherScheduleReferences contains all other references for the PlanningSchedule not explicitly stated as the content of other elements.Content: OrderNumber , OrderIssueDate (Type: datetime)? , OrderType?
Description: The ScheduleOrderReference element references the PurchaseOrder that the PlanningSchedule references.
OrderNumber indicates the unique number assigned to identify a purchase order.OrderIssueDate olds a digital time stamp provided by the application that created the Order document.OrderType identifies the type of order being referenced.Description:
This code identifies the type of schedule when defining shipping or delivery time in a schedule or forecast. This code list is derived from X12 675 (Schedule type qualifier)
Value: Enumeration, including:
Content: CategoryName* , ShortDescription* , LongDescription* , CategoryAttribute*
Attribute: Name: CategoryID - Data Type: ID - Default Value: #REQUIREDDescription: The SchemaCategory element List of categories. Should not be present if there is a SchemaSource element supplied to identify an external schema.
CategoryName contains the name of the category as given by its creator.ShortDescription is a short description of the category. 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, and defaults to en (for "English") if not present.LongDescription is a long description of the category. 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.".CategoryAttribute holds a list of the category's attribute definitions, as described in its child elements.CategoryID identifies the category. This is an XML ID value.ParentCategoryRef holds an XML IDREF value that points to a parent category, to allow for the hierarchical relationships of a classification to be captured in the schema categorization being described.Description: The CategoryName element contains the name of the category as given by its creator.
lang language for the text description.Content: SealInfo+
Description: The ListOfSealInfo element provides the information regarding the seals affixed to the equipment.
SealInfo provides seal information for the equipment.Content: SealNumber (Type: string) , SealIssuer? , SealStatusDescription?
Description: The SealInfo element provides seal information for the equipment.
SealNumber identifies the seal number of the equipment.SealIssuer provides information about the issuer of the seal for the equipment.SealStatusDescription provides information on the status of the seal.Content: SealStatusCoded (Type: SealStatusCode)? , SealStatusCodedOther (Type: string)? , SealStatusInfo (Type: string)?
Description: The SealStatusDescription element provides information on the status of the seal.
SealStatusCoded lists the status of the seal.SealStatusCodedOther is used to provide a non-standard SealStatusCode. This element is mandatory if the value of SealStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.SealStatusInfo provides text information regarding the seal status.Content: SealIssuerCoded (Type: SealIssuerCode) , SealIssuerCodedOther (Type: string)?
Description: The SealIssuer element provides information about the issuer of the seal for the equipment.
SealIssuerCoded lists the issuer of the seal for the equipment.SealIssuerCodedOther is used to provide a non-standard SealIssuerCode. This element is mandatory if the value of SealIssuerCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the issuer of the seal number. This code list is derived from EDIFACT 9303 (Sealing party coded)
Value: Enumeration, including:
Description:
This code identifies the status of the seal. This code list is derived from EDIFACT 4517 (Seal condition coded) and X12 407 (Seal status code)
Value: Enumeration, including:
Content: MessageTypeCoded (Type: MessageTypeCode) , MessageTypeCodedOther (Type: string)? , MessageClass (Type: string)? , MessageNumber (Type: int)? , MessageDescription (Type: string)?
Description: The SecondaryMessageInformation element contains details on transactions posted. Can be messages of type information, warnings or errors.
MessageTypeCoded contains coded information on the kind of message posted.MessageTypeCodedOther is used to provide a non-standard MessageTypeCode. This element is mandatory if the value of MessageTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.MessageClass Classifies Message-Number (e.g. MM is Materials Management).MessageNumber contains the number of the message.MessageDescription contains a detailed description of the above message.Description:
This code identifies the type of message posted.
Value: Enumeration, including:
Description:
This code indicates the special service required. This code list is derived from X12 1300 (Service, promotion, allowance or charge code)
Value: Enumeration, including:
Description:
This code indicates the level of service required. This code list is derived from EDIFACT 4183 (Special condition code), 4219 (Transport priority coded), and 8335 (Movement type description code) and X12 284 (Service level code)
Value: Enumeration, including:
Content: CommitmentLevelCoded (Type: CommitmentLevelCode) , CommitmentLevelCodedOther (Type: string)? , ScheduleDates (Type: ListOfDateCoded) , ScheduleQuantities (Type: ListOfQuantityCoded) , ItemResourceAuthorization? , ScheduleNote (Type: string)? , RouteID (Type: int)?
Description: The ShipScheduleDetail element provides the commitment level, dates, and quantity for the shipment.
CommitmentLevelCoded identifies the commitment level for the forecast.CommitmentLevelCodedOther is used to provide a non-standard CommitmentLevelCode. This element is mandatory if the value of ScheduleTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ScheduleDates is a list of forecasted dates and times corresponding to the commitment level for the given material and location.ScheduleQuantities is the quantity of the line item for the scheduled date.ItemResourceAuthorization is used to specify resource authorization in the schedule.ScheduleNote contains any free-form text pertinent to the entire ShippingSchedule. 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.RouteID references the route ID in TransportRouting.Content: ShipScheduleDetail+
Description: The ListOfShipScheduleDetail element is the detailed schedule information for the materials. Includes dates and quantity.
ShipScheduleDetail provides the commitment level, dates, and quantity for the shipment.Content: ShipToSubLocation (Type: Location) , ShipToSubQuantity (Type: Quantity) , SubLocationItemPackagingReference (Type: ItemPackagingReference)?
Description: The ShipToSubInformation element contains the information for the locations and quantities of the goods for the schedule lines.
ShipToSubLocation identifies places inside the ship to location where specific sub deliveries will be made. This is also called a mail stop.ShipToSubQuantity identifies the quantity associated with the ship to sub location.SubLocationItemPackagingReference is to be used when specifying packaging details related to each shipment to a sub location. The quantity fields should match the values in shipto sub quantity. These values override packaging references supplied at the delivery detail level.Content: ShipToSubInformation+
Description: The ListOfShipToSubInformation element details place and quantity information regarding the shipto sub-location.
ShipToSubInformation contains the information for the locations and quantities of the goods for the schedule lines.Content: ShippingScheduleHeader , (ListOfLocationGroupedShippingDetail | ListOfMaterialGroupedShippingDetail) , ListOfPackageDetail? , ShippingScheduleSummary?
Description: The ShippingSchedule element consists of notifications of short-term shipping requirements from a buyer to a supplier in reference to an existing planning schedule or purchasing agreement. The shipping schedule is not intended to be used for authorizing labor, materials, or other resources. The buyer will initially outline product requirements to the supplier in the form of a planning schedule or purchasing agreement. The Shipping Schedule will then be issued in reference to a planning schedule or purchasing agreement and provide specific details relating to the required products, quantities, delivery points and requested delivery dates. The Shipping Schedule document supersedes certain shipping and delivery information transmitted in a previous planning schedule, but does not replace it. Shipping schedules are usually stated in daily, weekly or monthly buckets (depending upon the industry) and are used to refine planning schedules in support of a just-in-time planning environment. This provides a mechanism to issue precise shipping schedule requirements on a more frequent basis than with the issuance of a planning schedule. The Shipping Schedule also provides the ability for a customer location to issue shipping requirements independent of other customer locations when planning schedules are issued by a consolidated scheduling organization.
ShippingScheduleHeader contains the header information of the ShippingSchedule..ListOfLocationGroupedShippingDetail contains the line level detail information for the ShippingSchedule document. The detail is grouped by the delivery point. This is one of two options for grouping the shipping detail.ListOfMaterialGroupedShippingDetail contains the line level detail information for the ShippingSchedule document. The detail is grouped by the material. This is one of two options for grouping shipping detail.ListOfPackageDetail is a container to hold a number of package details.ShippingScheduleSummary is the summary section for the ShippingSchedule document which contains a total number of lines.Content: ScheduleID (Type: string) , ScheduleIssuedDate (Type: datetime) , ScheduleReferences? , ReleaseNumber (Type: string)? , SchedulePurpose (Type: Purpose) , RequestedResponse? , ScheduleTypeCoded (Type: ScheduleTypeCode) , ScheduleTypeCodedOther (Type: string)? , QuantityQualifierCoded (Type: QuantityQualifierCode) , QuantityQualifierCodedOther (Type: string)? , ValidityDates? , ScheduleParty , ListOfTransportRouting? , TermsOfDelivery? , Language , ShippingScheduleHeaderNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The ShippingScheduleHeader element contains the header information of the ShippingSchedule..
ScheduleID contains a reference number to uniquely identify the ShippingSchedule..ScheduleIssuedDate is a digital time stamp the time the application created the ShippingSchedule document.ScheduleReferences is used to identify references to other documents and release information for the ShippingSchedule..ReleaseNumber identifies the specific iteration of the release against a given contract, purchase order, etc.SchedulePurpose indicates the intended use of the ShippingSchedule document.RequestedResponse specifies the type of acknowledgment requested by the buyer from the seller.ScheduleTypeCoded identifies the type of schedule when defining shipping or delivery time in a schedule or forecast.ScheduleTypeCodedOther is used to provide a non-standard ScheduleTypeCode. This element is mandatory if the value of ScheduleTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.QuantityQualifierCoded is the purpose of a quantity using a standard codelist.QuantityQualifierCodedOther is used to provide a non-standard QuantityQualifierCode. This element is mandatory if the value of QuantityQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ValidityDates is used to specify a start and end dates of a period which the element in which they are used is valid.ScheduleParty contains information on the parties to the ShippingSchedule, including unique ID's and address information.ListOfTransportRouting defines the information on the movement of the goods, including the carrier, equipment, locations and dates.TermsOfDelivery includes the information related to delivery including shipment method payment and transport.Language denotes the language the attachment is written in.ShippingScheduleHeaderNote contains any free-form text pertinent to the entire ShippingSchedule. 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 is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to a document that contain information relating to the document.Content: ShippingScheduleResponseHeader , (ListOfLocationGroupedShippingResponse | ListOfMaterialGroupedShippingResponse) , ShippingScheduleResponseSummary (Type: ShippingScheduleSummary)?
Description: The ShippingScheduleResponse element is a response to a previously sent ShippingSchedule. The intent of these documents is for sellers to provide changes or corrections to the original documents. A seller can reply back with changes to a schedule due to factors such as backorder, insufficient parts, cannot meet demand, incorrect information, etc. The choice between ListOfLocationGroupedShippingResponse and ListOfMaterialGroupedShippingResponse allows you to determine how the detail section will be structured. ListOfLocationGroupedShippingResponse groups the shipping schedule line items according to location and ListOfMaterialGroupedShippingResponse allows you to group the planning schedule line items according to product.
ShippingScheduleResponseHeader holds all ShippingScheduleResponse header-level information. This element occurs once within the document.ListOfLocationGroupedShippingResponse contains the line level detail information for the planning schedule. The detail is grouped by the delivery location. This is one of two options for grouping forecasting detail in the ShippingScheduleResponse document.ListOfMaterialGroupedShippingResponse contains the line level detail information for the planning schedule. The detail is grouped by the material. This is one of two options for grouping forecasting detail in the ShippingScheduleResponse document.ShippingScheduleResponseSummary provides summary information for the ShippingScheduleResponse document.Content: ScheduleResponseID (Type: string) , ScheduleResponseIssueDate (Type: datetime) , ScheduleReference (Type: Reference) , ListOfReferenceCoded? , BuyerParty (Type: Party) , SellerParty (Type: Party) , Purpose , ResponseType , Language , OriginalShippingScheduleHeader (Type: ShippingScheduleHeader)? , ChangedShippingScheduleHeader (Type: ShippingScheduleHeader)? , ShippingScheduleResponseHeaderNote (Type: string)? , ListOfStructuredNote? , ListOfAttachment?
Description: The ShippingScheduleResponseHeader element holds all ShippingScheduleResponse header-level information. This element occurs once within the document.
ScheduleResponseID contains a reference number to uniquely identify the ShippingSchedule.ScheduleResponseIssueDate is a digital time stamp, that the application creating the PlanningScheduleDocument generated.ScheduleReference is a reference to the original ShippingSchedule.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.BuyerParty is the buyer of the goods or services.SellerParty is the seller of the goods or services.Purpose is used to communicate the intended purpose of a document.ResponseType identifies the type of response intended by the document.Language denotes the language of the document.OriginalShippingScheduleHeader is used to hold the original ShippingScheduleHeader and can be used if needed. This is useful for comparison reasons but will seldom be used.ChangedShippingScheduleHeader contains any changes to the ShippingScheduleHeader that has changed. Note: If there are changes to the header, the entire header section should be repeated.ShippingScheduleResponseHeaderNote is a note containing general information for the ShippingScheduleResponse.ListOfStructuredNote is a structured note which contains an identifier and URL.ListOfAttachment holds a list of attachments to the document that contain information relating to the document.Content: TotalNumberOfLineItems (Type: int)
Description: The ShippingScheduleSummary element is the summary section for the ShippingSchedule document which contains a total number of lines.
TotalNumberOfLineItems is the total number of lines in the shipping schedule.Description: The ShortDescription element holds a short textual description. Has xml:lang attribute so there can be more than one ShortDescription in multiple languages. xml:lang must contain valid RFC 1766 language code.
lang language for the text description.Description:
This code indicates the significance of a measurement value. This code list is derived from EDIFACT 6321 (Measurement significance coded)
Value: Enumeration, including:
Content: SourceID (Type: string)? , TargetID (Type: string)?
Description: The SourceTargetID element provides containers to identify source and target values.
SourceID contains information describing the data originating from the source system.TargetID contains information describing the data originating from the target system.Content: SpecialHandlingCoded (Type: SpecialHandlingCode) , SpecialHandlingCodedOther (Type: string)? , SpecialHandlingNote (Type: string)?
Description: The SpecialHandling element describes any special handling relating to the package.
SpecialHandlingCoded contains the handling code.SpecialHandlingCodedOther is used to provide a non-standard SpecialHandlingCode. This element is mandatory if the value of SpecialHandlingCoded is 'Other'. These codes should not contain white space unless absolutely necessary.SpecialHandlingNote contains any notes relating to the special handling of the package.Description:
This code identifies any special transportation handling instructions. This code list is derived from X12 152 (Special handling code)
Value: Enumeration, including:
Content: RateRequestID (Type: Reference) , ConfirmationID (Type: string) , FXIdentificationData? , TargetCurrency (Type: Currency)? , FXReferenceNumber (Type: Reference)? , FXAmounts , ListOfFee? , FXTransactionTypeCoded (Type: FXTransactionTypeCode)? , FXTransactionTypeCodedOther (Type: string)? , FXQuoteTypeCoded (Type: FXQuoteTypeCode)? , FXQuoteTypeCodedOther (Type: string)? , FXDates?
Description: The SpotRateDetail element contains fields and elements specific to the spot rate quote. This structure is provided when the IndicativeIndicator is false.
RateRequestID contains an identification relevant to the spot rate transaction.ConfirmationID contains free form text pertinent to the confirmation identification.FXIdentificationData contains data relevant to identifying the parties involved in the spot rate transaction.TargetCurrency identifies the target currency of the rate of exchange (to currency).FXReferenceNumber contains a reference to the origins of the exchange rate quote. This contains the FX rate reference number.FXAmounts contains all amount data relevant to the spot rate quote.ListOfFee contains a list of fees and amounts pertinent to the spot FX rate quote.FXTransactionTypeCoded contains the specific type of FX transaction quoted.FXTransactionTypeCodedOther is used to provide a non-standard FXTransactionTypeCode. This element is mandatory if the value of FXTransactionTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FXQuoteTypeCoded contains the coded FXRate quote type.FXQuoteTypeCodedOther is used to provide a non-standard FXQuoteTypeCode. This element is mandatory if the value of FXQuoteTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FXDates contains dates relevant to the spot rate quote.Content: OriginatingFinancialInstitution (Type: FIAccountDetail)? , CardInfo? , PayeeParty (Type: Party)?
Description: The FXIdentificationData element contains data relevant to identifying the parties involved in the spot rate transaction.
OriginatingFinancialInstitution contains information pertinent to identifying a financial institution and an account within the financial institution that will be debited.CardInfo contains details for payments made via credit card. This includes credit card number, card type, card holder name, expiration date, and other pertinent information.PayeeParty describes the beneficiary of the payment and their identification number.Content: SettlementAmount (Type: MonetaryValue)? , DebitAmount (Type: MonetaryValue) , CreditAmount (Type: MonetaryValue)?
Description: The FXAmounts element contains all amount data relevant to the spot rate quote.
SettlementAmount contains the transaction settlement amount.DebitAmount contains the amount to be debited from the payers account.CreditAmount contains the amount to be credited to the payees account.Content: FXValueDate (Type: datetime)? , RemittanceDate (Type: datetime)? , QuoteExpirationDate (Type: datetime)? , ListOfDateCoded?
Description: The FXDates element contains dates relevant to the spot rate quote.
FXValueDate specifies the effective date for the transaction.RemittanceDate specifies the date the payment will be made.QuoteExpirationDate specifies the date and time of the expiration of the FX quote.ListOfDateCoded contains a list of DateCoded which is composed of a date and a date qualifier. This allows users to specify dates pertinent to the rate quote that is not explicitly defined in the document.Content: StatusEvent , ListOfStatusReason? , StatusNote (Type: string)? , ErrorInfo?
Description: The Status element contains the information necessary for reporting a status, this includes the event, the reason, notes and error information if applicable.
StatusEvent identifies the status of the purchase order.ListOfStatusReason holds a list of status reason.StatusNote contains general information about the status of an order.ErrorInfo is a container for the error details.Content: StatusEventCoded (Type: StatusEventCode) , StatusEventCodedOther (Type: string)?
Description: The StatusEvent element identifies the status of the purchase order.
StatusEventCoded lists the status of the event.StatusEventCodedOther is used to provide a non-standard StatusEventCode. This element is mandatory if the value of StatusEventCoded is 'Other". These codes should not contain white space unless absolutely necessary.Description:
This code identifies the status of the event.
Value: Enumeration, including:
Description:
This code indicates the status of the element it is associated with.
Value: Enumeration, including:
Content: StatusReasonCoded (Type: StatusReasonCode) , StatusReasonCodedOther (Type: string)?
Description: The StatusReason element provides a reason for the status.
StatusReasonCoded lists the status reason.StatusReasonCodedOther is used to provide a non-standard StatusReasonCode. This element is mandatory if the value of StatusReasonCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Content: StatusReason+
Description: The ListOfStatusReason element holds a list of status reason.
StatusReason provides a reason for the status.Description:
This code identifies the reason for the status.
Value: Enumeration, including:
Content: GeneralNote (Type: string)? , NoteID (Type: string)? , Agency? , NoteURL (Type: URI)?
Description: The StructuredNote element is a note that allows for an ID, URL, and a free form note field.
GeneralNote is used to provide a note in text form if desired.NoteID is an ID assigned to this note. Is an implied attribute.Agency is used to identify the agency that assigned the NoteID.NoteURL is the URL that this note is referencing. Is an implied attribute.Content: StructuredNote+
Description: The ListOfStructuredNote element 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.
StructuredNote is a note that allows for an ID, URL, and a free form note field.Extends: Party
Description: The Subsidiary element contains information relating to a third party or subsidiary associated with the payment document.
ListOfInvoicingDetail contains invoicing document line item detail along with any relevant adjustment detail.Content: Subsidiary+
Description: The ListOfSubsidiary element contains a set of subsidiary detail with associated invoicing and adjustment information. This structure is used in the case where the payment is made by a central party and invoice detail needs to be specified by subsidiary.
Subsidiary contains information relating to a third party or subsidiary associated with the payment document.Description:
This code identifies the surface layer or the position of the item that is being described by the ItemCharacteristic element. This code list is derived from EDIFACT 7383 (Surface layer code) and X12 752 (Surface/layer/position code)
Value: Enumeration, including:
Content: TaxFunctionQualifierCoded (Type: TaxFunctionQualifierCode) , TaxFunctionQualifierCodedOther (Type: string)? , TaxCategoryCoded (Type: TaxCategoryCode) , TaxCategoryCodedOther (Type: string)? , ReasonTaxExemptCoded (Type: ReasonTaxExemptCode)? , ReasonTaxExemptCodedOther (Type: string)? , TaxTypeCoded (Type: TaxTypeCode) , TaxTypeCodedOther (Type: Identifier)? , TaxPercent (Type: Decimal10_4)? , TaxPaymentMethodCoded (Type: TaxPaymentMethodCode)? , TaxPaymentMethodCodedOther (Type: string)? , TaxableAmount (Type: Decimal21_6)? , TaxableAmountInTaxAccountingCurrency (Type: Decimal21_6)? , TaxAmount (Type: Decimal21_6) , TaxAmountInTaxAccountingCurrency (Type: Decimal21_6)? , TaxLocation (Type: Location)?
Description: The Tax element is used to specify tax information.
TaxFunctionQualifierCoded indicates the function of the Tax element, e.g. tax, customs duty.TaxFunctionQualifierCodedOther is used to provide a non-standard TaxQualifierCode. This element is mandatory if the value of TaxQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TaxCategoryCoded indicates the category of the tax and, by implication, the tax rate that applies. The actual percentage is dependent on the tax jurisdiction.TaxCategoryCodedOther is used to provide a non-standard TaxCategoryCode. This element is mandatory if the value of TaxCategoryCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ReasonTaxExemptCoded explains why a TaxCategory is exempt.ReasonTaxExemptCodedOther is used to provide a non-standard ReasonTaxExemptCode. This element is mandatory if the value of ReasonTaxExemptCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TaxTypeCoded identifies the type of the tax.TaxTypeCodedOther is used to provide a non-standard TaxTypeCode. This element is mandatory if the value of TaxTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TaxPercent holds the tax rate as a percentage.TaxPaymentMethodCoded indicates the method by which the tax will be paid.TaxPaymentMethodCodedOther is used to provide a non-standard TaxPaymentMethodCode. This element is mandatory if the value of TaxPaymentMethodCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TaxableAmount holds the taxable amount in the invoice currency.TaxableAmountInTaxAccountingCurrency holds the taxable amount in the tax accounting currency.TaxAmount holds the tax amount in the invoice currency.TaxAmountInTaxAccountingCurrency holds the tax amount in the tax accounting currency.TaxLocation holds the location for which the tax applies.Description:
This code identifies the function of the tax element. This code list is derived from EDIFACT 5283 (Duty or tax or fee function code qualifier)
Value: Enumeration, including:
Description:
This code identifies the method by which the Tax will be paid.
Value: Enumeration, including:
Description:
This code identifies the category of the tax, and by implication, the tax rate that applies. This code list is derived from EDIFACT 5305(Duty or tax or fee category code) and X12 441 (Tax exempt code)
Value: Enumeration, including:
Description:
This code identifies the type of location. This codelist is derived from X12 309 (Location qualifier)
Value: Enumeration, including:
Extends: Tax
Description: The TaxReference element contains a reference to the tax information relevant to the order.
TaxTreatmentCoded indicates the tax treatment. This element is mandatory. It indicates how the LineItemSubTotal on an InvoiceDetail is calculated.TaxTreatmentCodedOther is used to provide a non-standard TaxTreatmentCode. This element is mandatory if the value of TaxTreatmentCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code indicates the level of tax deduction.
Value: Enumeration, including:
Content: TaxSummary (Type: Tax)+
Description: The ListOfTaxSummary element contains the summary of the tax information specified within the Invoice. This element is mandatory if tax elements occur in either the invoice header or any invoice detail item line.
TaxSummary holds the summerized total tax amount for each tax category in the invoice. This includes line items and allowance and charges at both line and header level.Description:
This code identifies the type of tax. This code list is derived from EDIFACT 5153 (Duty or tax or fee type name code) and X12 963 (Tax type code)
Value: Enumeration, including:
Content: TermsOfDeliveryFunctionCoded (Type: TermsOfDeliveryFunctionCode) , TermsOfDeliveryFunctionCodedOther (Type: string)? , TransportTermsCoded (Type: TransportTermsCode)? , TransportTermsCodedOther (Type: string)? , ShipmentMethodOfPaymentCoded (Type: ShipmentMethodOfPaymentCode) , ShipmentMethodOfPaymentCodedOther (Type: string)? , Location? , TermsOfDeliveryDescription (Type: string)? , TransportDescription (Type: string)? , RiskOfLossCoded (Type: RiskOfLossCode)? , RiskOfLossCodedOther (Type: string)? , RiskOfLossDescription (Type: string)?
Description: The TermsOfDelivery element includes the information related to delivery including shipment method of payment and transport.
TermsOfDeliveryFunctionCoded indicates whether the terms relate to e.g. price conditions, delivery conditions, transport conditions, or a combination of these.TermsOfDeliveryFunctionCodedOther is used to provide a non-standard TermsOfDeliveryFunctionCode. This element is mandatory if the value of TermsOfDeliveryFunctionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TransportTermsCoded is the terms of delivery or transport.TransportTermsCodedOther is used to provide a non-standard TransportTermsCode. This element is mandatory if the value of TransportTermsCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ShipmentMethodOfPaymentCoded is the method of payment for shipping charges, etc. Coded list.ShipmentMethodOfPaymentCodedOther is used to provide a non-standard ShipmentMethodOfPaymentCode. This element is mandatory if the value of ShipmentMethodOfPaymentCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Location is the location relevant to the terms of delivery specified.TermsOfDeliveryDescription is the text description on special conditions or notes on the delivery.TransportDescription is a description of transport.RiskOfLossCoded qualifies the risk of loss.RiskOfLossCodedOther is used to provide a non-standard RiskOfLossCode. This element is mandatory if the value of RiskOfLossCoded is 'Other'. These codes should not contain white space unless absolutely necessary.RiskOfLossDescription is a text description of the risk of loss information.Description:
This code identifies payment terms for transportation charges. This code list is derived from EDIFACT 4215 (Transport charges payment method code) and X12 146 (Shipment method of payment)
Value: Enumeration, including:
Description:
This code indicates the responsibility for risk of loss. This code list is derived from X12 54 (Risk of loss qualifier)
Value: Enumeration, including:
Description:
This code indicates what terms the delivery is based on. This code list is derived from EDIFACT 4055 (Delivery or transport terms function code)
Value: Enumeration, including:
Content: TimeSeriesHeader , TimeSeriesDetail , TimeSeriesSummary
Description: The TimeSeries element is a forecasting document that can be used to process data based on variable characteristics. Data is collected over a period of time, and time slices can be presented as a historical account or a planned forecast.
TimeSeriesHeader contains all time series header relevant information. The header data will include information such as source target ID, issue date, time series ID, reference information, purpose code, etc.TimeSeriesDetail contains detail information for the time series document. The TimeSeriesDetail defines the characteristic combination, key figure, unit of measure, and time series values of a given planning data. This element is broken down into two structures: ListOfTimeSeriesKeyFigures and ListOfCharacteristicCombinations. Both lists can occur independently of the other. If necessary, you can send only one of the data elements.TimeSeriesSummary contains all information relevant to the summary of the time series document.Description:
This code identifies the status of the TimeSeries message at line level.
Value: Enumeration, including:
Content: TimeSeriesBucket (Type: ValidityDates) , TimeSeriesValue (Type: float) , TimeSeriesDataNote (Type: string)?
Description: The TimeSeriesData element contains the time series data which is composed of time buckets and a value. This element can occur a multiple of times.
TimeSeriesBucket describes the date range of the time series value by specifying the start and end dates. The element is composed of a StartDate and an EndDate which are both of type datetime.TimeSeriesValue is the value of the time series data to be analyzed.TimeSeriesDataNote is associated with the time series data.Content: ListOfCharacteristicCombinations? , ListOfTimeSeriesKeyFigureData?
Description: The TimeSeriesDetail element contains detail information for the time series document. The TimeSeriesDetail defines the characteristic combination, key figure, unit of measure, and time series values of a given planning data. This element is broken down into two structures: ListOfTimeSeriesKeyFigures and ListOfCharacteristicCombinations. Both lists can occur independently of the other. If necessary, you can send only one of the data elements.
ListOfCharacteristicCombinations 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.ListOfTimeSeriesKeyFigureData contains a list of all the key figure and time series data related information.Description:
This code identifies any errors in the data of the response to the TimeSeriesRequest message.
Value: Enumeration, including:
Content: TimeSeriesIssueDate (Type: datetime) , TimeSeriesID (Type: Reference) , TimeSeriesPurposeCoded (Type: TimeSeriesPurposeCode) , TimeSeriesPurposeCodedOther (Type: string)? , TimeSeriesTimePeriod (Type: ValidityDates)? , TimeSeriesSystemType (Type: SourceTargetID)? , TimeSeriesPlanningData (Type: SourceTargetID) , TimeSeriesSelection (Type: SourceTargetID)? , TimeSeriesPlanningStep (Type: SourceTargetID)? , TimeSeriesParty , Language , GeneralNotes (Type: string)?
Description: The TimeSeriesHeader element contains all time series header relevant information. The header data will include information such as source target ID, issue date, time series ID, reference information, purpose code, etc.
TimeSeriesIssueDate indicates the date and time that the time series document is transmitted.TimeSeriesID contains a reference number to uniquely identify the time series document. The reference data type also contains an optional reference date. (This is assumed to be with respect to the source system.).TimeSeriesPurposeCoded is used to indicate the function of the time series document. The application can use this code to process the document appropriately.TimeSeriesPurposeCodedOther is used to provide a non-standard TimeSeriesPurposeCode. This element is mandatory if the value of TimeSeriesPurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TimeSeriesTimePeriod indicates the overall time period for which the time series data represents. The TimeSeriesTimePeriod consists of a start and end date.TimeSeriesSystemType identifies the application system type from which the data is originating with respect to the source and target systems. This is used to interpret the technical names being sent in the document.TimeSeriesPlanningData identifies the time series planning data with respect to the source or target system. This contains the name or ID of the planning data for a given planning system.TimeSeriesSelection identifies the technical name of the time series selection with respect to the source or target system. This is used to describe the primary keys of the database table at a technical level. On a higher level, this contains the name or ID given to describe the set of dimensions or parameters of the given planning data structure.TimeSeriesPlanningStep identifies the work flow planning step associated with the instance of the time series with respect to the source and target systems.TimeSeriesParty contains information describing all parties associated with the time series document. Data such as the identifier, name, address, and contact information is provided.Language denotes the language the attachment is written in.GeneralNotes contains information or instructions pertinent to the analysis of the time series data.Content: TimeSeriesKeyFigurePurposeCoded (Type: TimeSeriesPurposeCode)? , TimeSeriesKeyFigurePurposeCodedOther (Type: string)? , TimeSeriesKeyFigureResponseCoded (Type: TimeSeriesErrorCode)? , TimeSeriesKeyFigureResponseCodedOther (Type: string)? , CharacteristicCombinationID (Type: string) , KeyFigureInformation , UnitOfMeasurement , TimeSeriesData+
Description: The TimeSeriesKeyFigureData element defines the key figure and includes all of the time series data values.
TimeSeriesKeyFigurePurposeCoded is used to indicate the function of the key figure and time series data in the transmission of this document. The application can use this code to process the key figure and time series data appropriately.TimeSeriesKeyFigurePurposeCodedOther is used to provide a non-standard TimeSeriesKeyFigurePurposeCode. This element is mandatory if the value of TimeSeriesKeyFigurePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TimeSeriesKeyFigureResponseCoded indicates whether there was an error in the key figure. This code is sent in response to a TimeSeriesRequest.TimeSeriesKeyFigureResponseCodedOther is used to provide a non-standard TimeSeriesKeyFigureResponseCode. This element is mandatory if the value of TimeSeriesKeyFigureResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.CharacteristicCombinationID is the key to uniquely identify the characteristic combination.KeyFigureInformation is used to identify the name, type, and value of a key figure used in a time series with respect to the source or target systems.UnitOfMeasurement specifies the unit of measure of rate.TimeSeriesData contains the time series data which is composed of time buckets and a value. This element can occur a multiple of times.Content: TimeSeriesKeyFigureData+
Description: The ListOfTimeSeriesKeyFigureData element contains a list of all the key figure and time series data related information.
TimeSeriesKeyFigureData defines the key figure and includes all of the time series data values.Content: SourceParty (Type: Party)? , ReceiverParty (Type: Party)? , ListOfPartyCoded?
Description: The TimeSeriesParty element contains information describing all parties associated with the time series document. Data such as the identifier, name, address, and contact information is provided.
SourceParty contains information relevant to describing the party of the source system.ReceiverParty contains information relevant to describing the party of the target system.ListOfPartyCoded contains information relevant to describing parties other than the source target parties which are relevant to the time series data.Description:
This code identifies the purpose of the TimeSeries message.This is a subset code list derived from EDIFACT 1225 (Message Function, Coded) and X12 353 (Transaction Set Purpose Code) and 587 (Acknowledgement Type Code)
Value: Enumeration, including:
Content: TimeSeriesRequestHeader (Type: TimeSeriesHeader) , TimeSeriesRequestDetail , TimeSeriesRequestSummary (Type: TimeSeriesSummary)
Description: The TimeSeriesRequest element contains the TimeSeriesRequestHeader, Detail and Summary information relating to the request of a time series document. TimeSeries is a forecasting document that can be used to process data based on variable characteristics. Data is collected over a period of time, and time slices can be presented as a historical account or a planned forecast.
TimeSeriesRequestHeader includes information such as sender receiver ID, issue date, time series ID, reference information, purpose code, etc. The TimeSeriesRequestHeader is identical to the TimeSeriesHeader.TimeSeriesRequestDetail is similar to TimeSeriesDetail with a few minor changes. The ListOfCharacteristicCombinations is the same but the ListOfTimeSeriesKeyFigures contains only information for the key figure and no time series data.TimeSeriesRequestSummary contains all information relevant to the summary of the time series document.Content: ListOfCharacteristicCombinations? , ListOfKeyFigureData?
Description: The TimeSeriesRequestDetail element is similar to TimeSeriesDetail with a few minor changes. The ListOfCharacteristicCombinations is the same but the ListOfTimeSeriesKeyFigures contains only information for the key figure and no time series data.
ListOfCharacteristicCombinations contains a list of all the characteristic combinations for the time series.ListOfKeyFigureData contains a list of all the key figure and time series data related information.Content: TimeSeriesResponseHeader , TimeSeriesResponseDetail , TimeSeriesResponseSummary (Type: TimeSeriesSummary)
Description: The TimeSeriesResponse element contains all time series response header, detail and summary information relating to the response to a time series document. TimeSeries is a forecasting document that can be used to process data based on variable characteristics. Data is collected over a period of time, and time slices can be presented as a historical account or a planned forecast.
TimeSeriesResponseHeader contains all time series response header relevant information. The header data includes information such as sender receiver ID, issue date, time series ID and reference information, response code, etc.TimeSeriesResponseDetail contains the detail level information relating to the time series response.TimeSeriesResponseSummary contains all information relevant to the summary of the time series document.Description:
This code identifies the acknowledgement of the TimeSeriesRequest document.
Value: Enumeration, including:
Content: TimeSeriesDetailResponseCoded (Type: TimeSeriesActionCode) , TimeSeriesDetailResponseCodedOther (Type: string) , ListOfChangedCharacteristicCombinations (Type: ListOfCharacteristicCombinations)? , ListOfChangedTimeSeriesKeyFigureData (Type: ListOfTimeSeriesKeyFigureData)?
Description: The TimeSeriesResponseDetail element contains the detail level information relating to the time series response.
TimeSeriesDetailResponseCoded is the overall line level response code for the entire time series detail section. This is a subset of the ActionCode list.TimeSeriesDetailResponseCodedOther is used to provide a non-standard TimeSeriesDetailResponseCode. This element is mandatory if the value of TimeSeriesDetailResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfChangedCharacteristicCombinations contains a list of all the characteristic combinations for the time series that need to be changed.The ListOfChangedCharacteristicCombinations is identical to the ListOfCharacteristicCombinations with the exception that the response code is required.ListOfChangedTimeSeriesKeyFigureData contains a list of all the key figure and time series data related information that will need to be changed. The ListOfChangeTimeSeriesKeyFigureData is identical to the ListOfTimeSeriesKeyFigureData with the exception that the response code is required.Content: TimeSeriesResponseIssueDate (Type: datetime) , TimeSeriesResponseID (Type: Reference) , TimeSeriesReference (Type: Reference) , TimeSeriesPlanningData (Type: SourceTargetID)? , TimeSeriesResponseParty (Type: TimeSeriesParty) , TimeSeriesHeaderResponseCoded (Type: TimeSeriesResponseCode) , TimeSeriesHeaderResponseCodedOther (Type: string)? , ChangedTimeSeriesHeader (Type: TimeSeriesHeader)? , Language , GeneralNotes (Type: string)?
Description: The TimeSeriesResponseHeader element contains all time series response header relevant information. The header data includes information such as sender receiver ID, issue date, time series ID and reference information, response code, etc.
TimeSeriesResponseIssueDate indicates the date and time that the TimeSeries Response document is transmitted.TimeSeriesResponseID contains a reference number to uniquely identify the TimeSeries Response document. The reference data type also contains an optional reference date.TimeSeriesReference is the original time series document for which this response document refers to. The reference also includes an optional date field which can be used to indicate original create date.TimeSeriesPlanningData identifies the time series planning data with respect to the relevant source or target system. This contains the name or ID of the planning instance for a given planning system. For SAP users, this would be the planning book ID.TimeSeriesResponseParty contains information describing all parties associated with the time series response document. Data such as the name, address, and contact information is provided.TimeSeriesHeaderResponseCoded indicates the type of acknowledgement with respect to the time series document.TimeSeriesHeaderResponseCodedOther is used to provide a non-standard TimeSeriesHeaderResponseCode. This element is mandatory if the value of TimeSeriesHeaderResponseCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ChangedTimeSeriesHeader is the entire TimeSeriesHeader document as provided here. The purpose of this is to allow the user to make the appropriate changes to the time series header. You have the option of sending corrections to the time series header or just simply sending the response code.Language denotes the language the attachment is written in.GeneralNotes contains information or instructions pertinent to the analysis of the time series response data.Content: TotalTimeSeriesData (Type: int)? , TotalCharacteristicCombinations (Type: int)? , TotalKeyFigures (Type: int)?
Description: The TimeSeriesSummary element contains all information relevant to the summary of the time series document.
TotalTimeSeriesData is the total number of time series items given in the document.TotalCharacteristicCombinations is the total number of characteristic combinations given in the document.TotalKeyFigures is the total number of key figures.Content: TimezoneCoded (Type: TimezoneCode) , TimezoneCodedOther (Type: string)?
Description: The Timezone element identifies the time zone.
TimezoneCoded specifies the value of the timezone. This is an offset from Greenwich Mean Time.TimezoneCodedOther is used to provide a non-standard TimezoneCode. This element is mandatory if the value of TimezoneCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the actual time zone for a location.
Value: Enumeration, including:
Content: Timezone
Description: The ListOfTimezone element lists the time zones for the location.
Timezone defines the time zone.Content: TitleCoded (Type: TitleCode) , TitleCodedOther (Type: string)?
Description: The Title element contains the title of the user related to gender and marital status.
TitleCoded contains the individual's title.TitleCodedOther is used to provide a non-standard TitleCode. This element is mandatory if the value of TitleCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the title of the user.
Value: Enumeration, including:
Content: AcademicTitleCoded (Type: AcademicTitleCode) , AcademicTitleCodedOther (Type: string)?
Description: The AcademicTitle element contains the academic title of the user, e.g. Dr.
AcademicTitleCoded provides the tile of an individual relating to their academic qualifications.AcademicTitleCodedOther is used to provide a non-standard AcademicTitleCode. This element is mandatory if the value of AcademicTitleCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the academic title of the user.
Value: Enumeration, including:
Content: TrackingNumber (Type: Reference) , TrackingCallURL (Type: URI)?
Description: The TrackingInformation element contains the information to allow tracking of the ASN..
TrackingNumber contains the reference for tracking purposes.TrackingCallURL contains the tracking URL.Content: TradingPartnerOrganizationHeader , OrganizationAddresses , ListOfBankDetail*
Description: The TradingPartnerOrganization element holds all information necessary to create and change a trading partner organization.
TradingPartnerOrganizationHeader holds general information about an organization.OrganizationAddresses is a container to hold organization addresses.ListOfBankDetail contains the banking details of the trading partner.Content: TradingPartnerOrganization+
Description: The ListOfTradingPartnerOrganization element contains a list of one or more trading partners.
TradingPartnerOrganization holds all information necessary to create and change a TradingPartnerOrganization.Content: ListOfTradingPartnerOrganizationDeletion
Description: The TradingPartnerOrganizationDelete element holds information for deleting trading partner organizations.
ListOfTradingPartnerOrganizationDeletion contains the list of deleted trading partner organizations.Content: TradingPartnerOrganizationDeletion+
Description: The ListOfTradingPartnerOrganizationDeletion element contains a list of the trading partner organization deletions.
TradingPartnerOrganizationDeletion holds all information necessary to delete a trading partner organization.Content: TradingPartnerIdentifications (Type: Identifications) , TradingPartnerDisplayName (Type: string)
Description: The TradingPartnerOrganizationDeletion element holds information necessary to delete a trading partner organization.
TradingPartnerIdentifications contains the trading partner identifications.TradingPartnerDisplayName is used in the application user interface.Content: ValidityDates? , ListOfTradingPartnerType , TradingPartnerIdentifications (Type: Identifications) , TradingPartnerDisplayName (Type: string) , name1 (Type: string) , name2 (Type: string)? , name3 (Type: string)? , OrganizationLanguage (Type: Language) , OrganizationCurrency (Type: Currency) , TradingPartnerOrganizationVisibility , GeneralNotes (Type: string)?
Description: The TradingPartnerOrganizationHeader element holds general relevant information about an organization.
ValidityDates holds the dates the trading partner organization is valid within the marketplace.ListOfTradingPartnerType contains a list of one or more categories of the trading partners.TradingPartnerIdentifications is an identification structure containing all possibilities of identifying a trading partner or contact and also enabling referencing to one of those.TradingPartnerDisplayName is the name displayed in the application's user-interface.name1 contains the first name line of an organization.name2 contains the second name line of an organization.name3 contains the third name line of an organization.OrganizationLanguage contains the main communication language of the organization.OrganizationCurrency contains the home-currency of the organization. It corresponds to the main general ledger currency of the organization.TradingPartnerOrganizationVisibility specifies visibility scope of a trading partners information.GeneralNotes contains any free-form text pertinent to the entire trading partner organization described by the TradingPartnerOrganization or to the TradingPartnerOrganization 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.Content: TradingPartnerOrganizationVisibilityCoded (Type: TradingPartnerOrganizationVisibilityCode) , TradingPartnerOrganizationVisibilityCodedOther (Type: string)?
Description: The TradingPartnerOrganizationVisibility element specifies visibility scope of a trading partners information.
TradingPartnerOrganizationVisibilityCoded specifies the visibility scope of a trading partner's information. Depending on the code used, applications can control who is able to view trading partner information.TradingPartnerOrganizationVisibilityCodedOther is used to provide a non-standard TradingPartnerOrganizationVisibilityCode. This element is mandatory if the value of TradingPartnerOrganizationVisibilityCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code is used to allow the application to control who is able to view trading partner information.
Value: Enumeration, including:
Content: TradingPartnerOrganizationPurpose , ListOfTradingPartnerOrganization
Description: The TradingPartnerOrganizationInformation element holds all information necessary to create and change a trading partner organization.
TradingPartnerOrganizationPurpose describes the purpose of the trading partner organization.ListOfTradingPartnerOrganization contains a list of one or more trading partners.Content: TradingPartnerOrganizationPurposeCoded (Type: TradingPartnerOrganizationPurposeCode) , TradingPartnerOrganizationPurposeCodedOther (Type: string)?
Description: The TradingPartnerOrganizationPurpose element contains a subset of the PurposeCode to give the purpose of the message.
TradingPartnerOrganizationPurposeCoded is an action code which describes whether the receiving application shall create / change etc. data.TradingPartnerOrganizationPurposeCodedOther is used to provide a non-standard TradingPartnerOrganizationPurposeCode. This element is mandatory if the value of TradingPartnerOrganizationPurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code indicates the purpose of the TradingPartnerOrganization message.
Value: Enumeration, including:
Content: ListOfTradingPartnerResponseInfo
Description: The TradingPartnerResponse element is the response to creating or changing trading partner organizations or users.
ReturnMessageInformation contains the return message.Content: TradingPartnerResponseInfo+
Description: The ListOfTradingPartnerResponseInfo element contains details on one or more responses posted.
TradingPartnerResponseInfo contains the response information.Content: ReturnMessageInformation , ListOfReturnedIdentification? , RedirectURL (Type: URI)? , ServiceID (Type: string)?
Description: The TradingPartnerResponseInfo element contains the information on the trading partner response.
ReturnMessageInformation contains the information on the trading partner response.ListOfReturnedIdentification contains a list of one or more IDs that have been created or changed.RedirectURL contains the URL to the full error info of any problem that occurs.ServiceID contains the information on the service ID.Content: PrimaryMessageInformation , ListOfSecondaryMessageInformation?
Description: The ReturnMessageInformation element is a container for the return message information.
PrimaryMessageInformation holds information on what happened to the actual initial document. Did the request succeed or did an error occur? This is for quick access to what happened. Details will be in SecondaryMessageInformation.ListOfSecondaryMessageInformation contains details on transactions posted. Can be messages of type information, warnings or errors.Content: SecondaryMessageInformation+
Description: The ListOfSecondaryMessageInformation element contains details on transactions posted. Can be messages of type information, warnings or errors.
SecondaryMessageInformation contains details on transactions posted.Content: TradingPartnerTypeCoded (Type: TradingPartnerTypeCode) , TradingPartnerTypeCodedOther (Type: string)?
Description: The TradingPartnerType element indicates the role(s) of the trading partner within the marketplace.
TradingPartnerTypeCoded indicates the role of the trading partner.TradingPartnerTypeCodedOther is used to provide a non-standard TradingPartnerTypeCode. This element is mandatory if the value of TradingPartnerTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code indicates the role of the trading partner.
Value: Enumeration, including:
Content: TradingPartnerType+
Description: The ListOfTradingPartnerType element contains a list of one or more TradingPartnerType.
TradingPartnerType allows the registration of the role of the trading partner.Content: TradingPartnerOrganizationReference (Type: Identifications) , UserID , PersonProfile , ListOfUserRole? , UserAdministration? , ListOfContactRelationType (Type: ContactRelationType)?
Description: The TradingPartnerUser element holds all information necessary to create or change a trading partner user.
TradingPartnerOrganizationReference provides an identification structure containing all possibilities of identifying a trading partner or contact and also enabling referencing to one of those.UserID contains the unique identifier for the trading partner. It is only unique within one trading partner organization.PersonProfile contains the user profile.ListOfUserRole contains list of one or more user roles.UserAdministration stores administrative information of a user. IF REGISTERING AN ORGANIZATION, YOU MUST INCLUDE ONE USER AND THIS USER MUST HAVE USER ADMIN PROPERTIES.ListOfContactRelationType contains a list of one or more ContactRelationType. If a contact shall be created without a user the ListOfUserRoles and UserAdministration is left out.Content: TradingPartnerUser+
Description: The ListOfTradingPartnerUser element contains a list of one or more trading partner users.
TradingPartnerUser contains all information necessary to create and change a trading partner user.Description: The UserID element contains the unique identifier for the trading partner. It is only unique within one trading partner organization.
UserShortID is a short User ID which is unique within a marketplace.Content: ListOfTradingPartnerUserDeletion
Description: The TradingPartnerUserDelete element provides the information necessary for deleting trading partner users from a trading partner directory..
ListOfTradingPartnerUserDeletion contains a list of one or more deleted trading partner users.Content: TradingPartnerUserDeletion+
Description: The ListOfTradingPartnerUserDeletion element contains a list of the trading partner user deletions contained within this message.
TradingPartnerUserDeletion contains the information for deletion of users.Content: TradingPartnerOrganizationReference (Type: Identifications) , UserID
Description: The TradingPartnerUserDeletion element holds all information necessary to delete a trading partner user.
TradingPartnerOrganizationReference contains the trading partner references.UserID contains a trading partner unique UserID. Only unique within one trading partner organization.Content: TradingPartnerUserPurpose , ListOfTradingPartnerUser
Description: The TradingPartnerUserInformation element is used to create or update trading partner user information in a trading partner directory within a marketplace.
TradingPartnerUserPurpose defines the purpose of the TradingPartnerUserInformation.ListOfTradingPartnerUser contains a list of one or more trading partner users.Content: TradingPartnerUserPurposeCoded (Type: TradingPartnerUserPurposeCode) , TradingPartnerUserPurposeCodedOther (Type: string)?
Description: The TradingPartnerUserPurpose element contains a subset of the PurposeCode to give the purpose of the message.
TradingPartnerUserPurposeCoded is an action code which describes whether the receiving application shall create or change data.TradingPartnerUserPurposeCodedOther is used to provide a non-standard TradingPartnerUserPurposeCode. This element is mandatory if the value of TradingPartnerUserPurposeCoded is 'Other". These codes should not contain white space unless absolutely necessary.Description:
indicates the purpose of the TradingPartnerUser message.
Value: Enumeration, including:
Content: TransitDirectionCoded (Type: TransitDirectionCode) , TransitDirectionCodedOther (Type: string)? , TransitTimeQualifierCoded (Type: TransitTimeQualifierCode)? , TransitTimeQualifierCodedOther (Type: string)? , TransitTime (Type: number)?
Description: The TransitDirection element details the direction of the transport.
TransitDirectionCoded outlines the transit direction for the shipment.TransitDirectionCodedOther is used to provide a non-standard TransitDirectionCode. This element is mandatory if the value of TransitDirectionCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TransitTimeQualifierCoded specifies the value of time used to measure the transit time.TransitTimeQualifierCodedOther is used to provide a non-standard TransitTimeQualifierCode. This element is mandatory if the value of TransitTimeQualifierCoded is 'Other'. These codes should not contain white space unless absolutely necessary.TransitTime is the numeric amount of transit time.Description:
This code identifies the transit direction for a shipment. This code list is derived from EDIFACT 8101 (Transit direction indicator code) and X12 731 (Transit direction code)
Value: Enumeration, including:
Description:
This code indicates the unit of time used to measure the transit time. This code list is derived from X12 732 (Transit time direction qualifier)
Value: Enumeration, including:
Content: TransportID (Type: int) , TransportMode? , TransportMeans? , CarrierID (Type: Identifier)? , CustShippingContractNum (Type: string)? , ServiceLevelCoded (Type: ServiceLevelCode)? , ServiceLevelCodedOther (Type: string)? , ShippingInstructions (Type: string)? , ListOfTransportEquipment? , TransitDirection? , TransportNote (Type: string)?
Description: The Transport element is a single routing defined by one carrier (that is, one organization operating equipment) moving between two or more locations with a single mode of transport. You may have more than one vehicle acting as part of the transport, but all must use the same route, be of the same mode, and be operated by the same carrier.
TransportID is a unique identifier for this route of transport to be referenced. Intended to be used as an internal reference for the document.TransportMode specifies the method or type of transportation of the shipment. Typically this may be sea, air or road.TransportMeans specifies the means of transportation for the route. Typically this may be by truck, sea- going vessel or aircraft.CarrierID is the ID assigned by the agency to the carrier. This identifies the carrier being used for the route.CustShippingContractNum provides a shipping contract number to allow supplier to ship goods under specific freight conditions or the carrier to bill against a specific contract number.ServiceLevelCoded is a code defining the level of service required.ServiceLevelCodedOther is used to provide a non-standard ServiceLevelCode. This element is mandatory if the value of ServiceLevelCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ShippingInstructions is free form text for special shipping instructions.ListOfTransportEquipment identifies and describes the equipment to be used on the route.TransitDirection details the direction of the transport.TransportNote is the text relating to the transport.Content: Transport+
Description: The ListOfTransport element provides information on the movement of the goods including carrier, equipment and service level instructions.
Transport is a single routing defined by one carrier (that is, one organization operating equipment) moving between two or more locations with a single mode of transport. You may have more than one vehicle acting as part of the transport, but all must use the same route, be of the same mode, and be operated by the same carrier.Content: EquipmentProviderCoded (Type: EquipmentProviderCode)? , EquipmentProviderCodedOther (Type: string)? , EquipmentOwnerCoded (Type: EquipmentOwnerCode)? , EquipmentOwnerCodedOther (Type: string)? , EquipmentID (Type: string) , EquipmentSizeTypeCoded (Type: EquipmentSizeTypeCode)? , EquipementSizeTypeCodedOther (Type: string)? , EquipmentStatusCoded (Type: EquipmentStatusCode)? , EquipmentStatusCodedOther (Type: string)? , FullIndicatorCoded (Type: FullIndicatorCode)? , FullIndicatorCodedOther (Type: string)? , Conditions? , EquipmentNote (Type: string)? , ListOfSealInfo? , ListOfEquipmentMeasurements (Type: ListOfDimension)?
Description: The TransportEquipment element identifies the vessel/vehicle or package serving as the equipment for this leg of transport.
EquipmentProviderCoded identifies the provider of the transport equipment.EquipmentProviderCodedOther is used to provide a non-standard EquipmentProviderCode. This element is mandatory if the value of EquipmentProviderCoded is 'Other'. These codes should not contain white space unless absolutely necessary.EquipmentOwnerCoded lists the code indicating the relationship of equipment to carrier or ownership of equipment.EquipmentOwnerCodedOther is used to provide a non-standard EquipmentOwnerCode. This element is mandatory if the value of EquipmentOwnerCoded is 'Other'. These codes should not contain white space unless absolutely necessary.EquipmentID holds the identification number for the equipment for the purposes of referencing within the document domain.EquipmentSizeTypeCoded lists the size and type codes for the equipment.EquipmentSizeTypeCodedOther is used to provide a non-standard EquipmentSizeTypeCode. This element is mandatory if the value of EquipmentSizeTypeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.EquipmentStatusCoded describes the status of the equipment.EquipmentStatusCodedOther is used to provide a non-standard EquipmentStatusCode. This element is mandatory if the value of EquipmentStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.FullIndicatorCoded describes the fill status of the equipment.FullIndicatorCodedOther is used to provide a non-standard FullIndicatorCode. This element is mandatory if the value of FullIndicatorCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Conditions describes the special conditions regarding the equipment.EquipmentNote holds free text information for the equipment.ListOfSealInfo provides the information regarding the seals affixed to the equipment.ListOfEquipmentMeasurements lists measurement information on the piece of equipment.Description:
This code identifies the fill status of the equipment. This code list is derived from EDIFACT 8169 (Full/empty indicator, coded)
Value: Enumeration, including:
Content: RefrigerationOn (Type: boolean)? , Residue (Type: boolean)? , ListOfConditions (Type: ListOfDimension)?
Description: The Conditions element describes the special conditions regarding the equipment.
RefrigerationOn defines whether the refrigeration is on or off.Residue indicates that the shipment is not a loaded movement but contains a residue from a prior movement.ListOfConditions lists the conditions of the equipment.Content: TransportEquipment+
Description: The ListOfTransportEquipment element contains a list of one or more vessel/vehicle or package serving as the equipment for this leg of transport.
TransportEquipment identifies the vessel/vehicle or package serving as the equipment for this leg of transport.Description:
This code indicates the stages of the transportation. This code list is derived from EDIFACT 8051 (Transport Stage Code Qualifier) and X12 133 (Routing Sequence code)
Value: Enumeration, including:
Content: TransportMeansCoded (Type: TransportMeansCode) , TransportMeansCodedOther (Type: string)?
Description: The TransportMeans element contains the information on the means of transport for the route.
TransportMeansCoded lists the means of transport for this route.TransportMeansCodedOther is used to provide a non-standard TransportMeansCode. This element is mandatory if the value of TransportMeansCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the means of transportation. This codelist is derived from EDIFACT 8179(Transport Means Description Code) and X12 40 (Equipment Description Code)
Value: Enumeration, including:
Content: TransportModeCoded (Type: TransportModeCode) , TransportModeCodedOther (Type: string)?
Description: The TransportMode element is a container for the TransportModeCode.
TransportModeCoded holds the mode of transportation for this route.TransportModeCodedOther is used to provide a non-standard TransportModeCode. This element is mandatory if the value of TransportModeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the mode of transportation. This code list is derived from EDIFACT Recommendation 19 (Mode of Transport) and X12 91 (Transportation Method/Type Code)
Value: Enumeration, including:
Content: TotalPackages (Type: int)? , TotalPackageDepth (Type: int)? , TotalTransport (Type: int)? , TotalGrossWeight (Type: Measurement)? , TotalNetWeight (Type: Measurement)? , TotalNetNetWeight (Type: Measurement)? , TotalTareWeight (Type: Measurement)? , GrossVolume (Type: Measurement)?
Description: The TransportPackagingTotals element summarizes the transport and packaging information if included in a document.
TotalPackages is the summation of total packages contained in the document.TotalPackageDepth describes the nesting level of the package count in the preceding element, if that number counts other than top-level packages.TotalTransport is the summation of the total top level packages contained in the document, unless otherwise described. Total transport is the number of top-level packages, unless described otherwise in TotalPackageDepth.TotalGrossWeight is the total gross weight of the shipment.TotalNetWeight is the total net weight of the shipment.TotalNetNetWeight is the weight (mass) of the goods themselves without any packing. This is particularly important for the industries like tobacco where tax is calculated on the weight of the cigarettes rather than on the retail item.TotalTareWeight is the weight of the goods minus the transport equipment.GrossVolume is the total volume of the shipment.Content: TransportRouteID (Type: int) , TransportMode? , TransportMeans? , TransportMeansIdentifier (Type: Identifier)? , TransportMeansReference (Type: Identifier)? , TransportRequirementCoded (Type: TransportRequirementCode)? , TransportRequirementCodedOther (Type: string)? , CarrierID (Type: Identifier)? , TransportQuantities? , CustShippingContractNum (Type: string)? , ServiceLevel? , ShippingInstructions (Type: string)? , TransportLegCoded (Type: TransportLegCode)? , TransportLegCodedOther (Type: string)? , ListOfTransportEquipment? , TransitDirection? , TransportLocationList
Description: The TransportRouting element holds the definition of the transport routing. A single TransportRouting is defined by one carrier (that is, one organization operating equipment) moving between two or more locations with a single mode of transport. You may have more than one vehicle acting as part of the transport, but all must use the same route, be of the same mode, and be operated by the same 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.TransportMode is a container for the TransportModeCode.TransportMeans contains the information on the means of transport for the route.TransportMeansIdentifier holds a name or number appearing visibly on the outside of the transport means. Transport mean values include the vehicle registration number, flight number or vessel name.TransportMeansReference references a means of transport. Typically, this is an identifier assigned by some organization that is not obvious or apparent on the outside of the vessel. Possible transport means reference values include (eg Lloyds number or call sign for maritime vessels).TransportRequirementCoded is used to specify options for satisfying vessel or transport requirements.TransportRequirementCodedOther is used to provide a non-standard TransportRequirementCode. This element is mandatory if the value of TransportRequirementCoded is 'Other'. These codes should not contain white space unless absolutely necessary.CarrierID is the ID assigned by an agency to the carrier.TransportQuantities is used to identify quantities relative to the shipment such as lading and hazardous reportable, and radioactive quantities.CustShippingContractNum provides a shipping contract number to allow supplier to ship goods under specific freight conditions or the carrier to bill against a specific contract number.ServiceLevel is used to hold information about the level of service associated with the transportation.ShippingInstructions holds any notes specific to shipping.TransportLegCoded lists the stages of the transport.TransportLegCodedOther is used to provide a non-standard TransportLegCode. This element is mandatory if the value of TransportLegCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ListOfTransportEquipment provides details about the equipment used for transportation.TransitDirection details the direction of transportation.TransportLocationList lists the locations through which the transportation goes.Description:
This code identifies specific transport or vessel requirements. This code list is derived from X12 249 (Vessel requirement code)
Value: Enumeration, including:
Content: StartTransportLocation (Type: TransportLocation) , InterimTransportLocation (Type: TransportLocation)* , EndTransportLocation (Type: TransportLocation)
Description: The TransportLocationList element lists the locations through which the transportation goes.
StartTransportLocation identifies the location where the transport routing starts.InterimTransportLocation identifies all locations along the route between the start and end locations.EndTransportLocation identifies the end transport location information.Content: Location , LocationID (Type: int) , Sequence (Type: int)? , EstimatedArrivalDate (Type: datetime)? , ActualArrivalDate (Type: datetime)? , EstimatedDepartureDate (Type: datetime)? , ActualDepartureDate (Type: datetime)?
Description: The TransportLocation element provides information about a stop along a transport route.
Location identifies a specific location of the stop either by an identifier or by an explicit address.LocationID holds the unique number referenced internally from line item package and detail.Sequence holds the counter that indicates the sequence of stops within the transport routing. Start transport location always has a sequence of one.EstimatedArrivalDate identifies the estimated date that the transport arrives at the location.ActualArrivalDate identifies the actual date that the transport arrives at the location.EstimatedDepartureDate identifies the estimated date that the transport departs from the location .ActualDepartureDate identifies the actual date that the transport departs from the location.Content: LadingQuantity (Type: Quantity)? , ListOfQuantityCoded?
Description: The TransportQuantities element is used to identify quantities relative to the shipment such as lading and hazardous reportable, and radioactive quantities.
LadingQuantity is the quantity of items being transported by the carrier.ListOfQuantityCoded is used to define other quantities relative to the shipment.Content: ServiceLevelCoded (Type: ServiceLevelCode)? , ServiceLevelCodedOther (Type: string)? , ServiceLevelReasonCoded (Type: ServiceLevelReasonCode)? , ServiceLevelReasonCodedOther (Type: string)? , ServiceLevelResponsibilityCoded (Type: ServiceLevelResponsibilityCode)? , ServiceLevelResponsibilityCodedOther (Type: string)?
Description: The ServiceLevel element is used to hold information about the level of service associated with the transportation.
ServiceLevelCoded is a code defining the level of service required.ServiceLevelCodedOther is used to provide a non-standard ServiceLevelCode. This element is mandatory if the value of ServiceLevelCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ServiceLevelReasonCoded defines the reason the level of service is required using a standard codelist.ServiceLevelReasonCodedOther is used to provide a non-standard ServiceLevelReasonCode. This element is mandatory if the value of ServiceLevelReasonCoded is 'Other'. These codes should not contain white space unless absolutely necessary.ServiceLevelResponsibilityCoded identifies the party responsible for the level of service.ServiceLevelResponsibilityCodedOther is used to provide a non-standard ServiceLevelResponsibilityCode. This element is mandatory if the value of ServiceLevelResponsibilityCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the reason for shipment via premium transportation rather than the normal mode. This code list is derived from X12 626 (Excess transportation reason code)
Value: Enumeration, including:
Description:
This code indicates the party responsible for the level of service requested. This code list is derived from X12 627 (Excess transportation responsibility code)
Value: Enumeration, including:
Content: TransportRouting+
Description: The ListOfTransportRouting element defines the information on the movement of the goods, including the carrier, equipment, locations and dates.
TransportRouting holds the definition of the transport routing. A single TransportRouting is defined by one carrier (that is, one organization operating equipment) moving between two or more locations with a single mode of transport. You may have more than one vehicle acting as part of the transport, but all must use the same route, be of the same mode, and be operated by the same carrier.Description:
This code indicates the terms of delivery. This code list is derived from INCOTERMS 1990
Value: Enumeration, including:
Content: UOMCoded (Type: UOMCode) , UOMCodedOther (Type: string)?
Description: The UnitOfMeasurement element specifies the units which relate to the measurement or quantity.
UOMCoded is used to define the unit of measure.UOMCodedOther is used to provide a non-standard UOMCode. This element is mandatory if the value of UOMCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the unit of measurement. This code list is derived from UNECE Rec 20 and X12 355 (Unit or Basis for measurement code)
Value: Enumeration, including:
Content: ValidityDates? , UserStatus?
Description: The UserAdministration element is for storing administrative information of a user. IF REGISTERING AN ORGANIZATION MUST INCLUDE ONE USER AND THIS USER MUST HAVE USER ADMIN PROPERTIES.
ValidityDates defines the date range that the user administration is valid in the trading partner directory.UserStatus is a container to hold the status of the user.Content: UserStatusCoded (Type: UserStatusCode) , UserStatusCodedOther (Type: string)?
Description: The UserStatus element is a container to hold the status.
UserStatusCoded contains coded list to define the status of the user. This is a subset of the Status List.UserStatusCodedOther is used to provide a non-standard UserStatusCode. This element is mandatory if the value of UserStatusCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the status of the user in the TradingPartner message.
Value: Enumeration, including:
Content: UserRoleAuthority (Type: string)? , UserRoleName (Type: string)
Description: The UserRole element indicates the type and role of a user of a trading partner. Examples could be Employee, Manager, Secretary etc. This is the role defined by the marketsite, and has implications for authorization within services, and as an administrator at the marketsite.
UserRoleAuthority defines marketsite application name. Assumed default is the marketplace if not present.UserRoleName is the role of the trading partner user.Content: UserRole+
Description: The ListOfUserRole element contains a list of one or more UserRole.
UserRole indicates the type and role of a user of a trading partner. Examples could be Employee, Manager, Secretary etc. This is the role defined by the marketsite, and has implications for authorization within services, and as an administrator at the marketsite.Content: StartDate (Type: datetime) , EndDate (Type: datetime)
Description: The ValidityDates element is used to specify a start and end dates of a period which the element in which they are used is valid.
StartDate specifies the first point in time on which validity/effectivity occurs.EndDate specifies the last point in time for which a validity/effectivity occurs.Content: VisibilityIndicator (Type: boolean)? , VisibilityOfComments (Type: boolean)? , VisibilityOfAmounts (Type: boolean)? , VisibilityOfQuantities (Type: boolean)? , VisibilityOfParticipants (Type: boolean)?
Description: The VisibilityRules element indicates the visibility level of the auction. If the information is not provided, then the assumption is made that the auction is public and that all values are visible.
VisibilityIndicator is a general indicator to specify whether or not the auction is public or private.True: auction is public
False: auction is private
VisibilityOfComments indicates if an auction participant can access the comments of other participants.True: Other bidder's comments are visible
False: Other bidder's comments are not visible
VisibilityOfAmounts indicates if an auction participant can access the bid amounts of other participants.True: Other's bid amounts are visible
False: Other's bid amounts are not visible
VisibilityOfQuantities indicates if an auction participant can access the bid quantities of other participants.True: Other's bid quantities are visible
False: Other's bid quantities are not visible
VisibilityOfParticipants indicates if an auction participant can access the identities of other participants.True: Other participant names are visible
False: Other participant names are not visible
Description:
This code indicates how the winner of the auction is determined.
Value: Enumeration, including:
Content: ListOfCertificatePurpose* , (X509Cert (Type: string) | X509CertificateInfo)
Description: The X509Certificate element describes how a user certificate should look.
ListOfCertificatePurpose contains a list of one or more CertificatePurpose elements.X509Cert is a MIME-encoded Certificate.X509CertificateInfo contains information regarding the X509 Certificate.Content: X509Certificate*
Description: The ListOfX509Certificate element contains a list of one or more X509Certificate.
X509Certificate is a standard field describing how a user certificate should look.Content: CertificatePurpose*
Description: The ListOfCertificatePurpose element contains a list of one or more CertificatePurpose.
CertificatePurpose identifies the purpose of the certificate.Content: CertificatePurposeCoded (Type: CertificatePurposeCode) , CertificatePurposeCodedOther (Type: string)?
Description: The CertificatePurpose element identifies the purpose of the certificate.
CertificatePurposeCoded contains the code identifying the purpose of the certificate.CertificatePurposeCodedOther is used to provide a non-standard CertificatePurposeCode. This element is mandatory if the value of CertificatePurposeCoded is 'Other'. These codes should not contain white space unless absolutely necessary.Description:
This code identifies the purpose of the certificate.
Value: Enumeration, including:
Content: X509Subject (Type: string) , X509Issuer (Type: string) , X509SerialNumber (Type: string)
Description: The X509CertificateInfo element contains information regarding the X509 certificate.
X509Subject is the Subject.X509Issuer is the Issuer.X509SerialNumber states the serial number of the certificate.boolean: A value of either true or false
string: A sequence of characters.
Format: X*
URI: A sequence of characters forming a valid URI.
number: An infinite precision number.
Format: [+-][0-9]*[.[0-9]*]?
float: A single precision floating point number in the range -3.40282347 * 10E38 to 3.40282347 * 10E38
Format: [+-][0-9]*[.[0-9]*]?
double: A double precision floating point number in the range -1.17549435 * 10E308 to 1.17549435 * 10E308
Format: [+-][0-9]*[.?[0-9]*]?
int: An integer in the range -2,147,483,648 to 2,147,483,647
Format: [+-]?[0-9]*
long: An integer in the range -9,223,372,036,854,775,808 to 9,223,372,036,854,775,807
Format: [+-]?[0-9]*
byte: An integer in the range -128 to 127
Format: [+-]?[0-9]*
ID: An ID is a name which must be unique within the instance and names the node for which it is defined. The value of an ID cannot be reused within the instance.
Format: NMTOKEN production of XML 1.0 specification.
IDREF: An IDREF must contain the value of an ID string declared elsewhere in the document.
IDREFS: A list of whitespace delimited IDREF values.
NMTOKEN: A string corresponding to the values of the NMTOKEN production of the XML 1.0 specification.
NMTOKENS: A list of whitespace delimited NMTOKEN values.
date: A date including month, day, and year
Format: YYYYMMDD
time: A time accurate to the nearest second with optional offset from GMT
Format: HH:MM:SS[[+-]HH:MM]?
datetime: A combination Date and Time. Note the presence of a T character between the date and time portions, and the use of colons to separate hours, minutes, and seconds. These are as per ISO 8601.
Format: YYYYMMDDTHH:MM:SS[[+-]HH:MM]? (the first MM is Months, the other two are minutes)