XHE cs01 - ExchangeHeaderEnvelope

Index for all items: AVA BUS CON CRE CUS DES DOC EXT FRO HAN HEA ID INS LOG PAR PAS PAY PRO REL TOP UUI VAL XHE ExchangeHeaderEnvelope XHE-CommonLibrary-1.0 Unqualified Data Types Summary

Copyright © UN/CEFACT; Copyright © OASIS Open

Rendering: 20190506-0130z

Legends: Summary Legend: Name (Model line Object) TYPE Description
Table Legend: ^ = up-link to the containing ABIE of the BBIE or the ASBIE (hover to see ABIE name)
< = back-link to the ASBIE using the ABIE, or to the BBIE using the data type (hover to see destination)
Line number links: alternate between summary view and table view


ExchangeHeaderEnvelope

Name CEFACT Dictionary Entry Name Card. Rep. Term Dictionary Entry Name Ver. Comp.
Type
Class Prop. Term
Poss. Noun
Prop. Term
Prim. Noun
Prop. Term Data Type Assoc.
Class
2 XHE
The Exchange Header Envelope
XHE_ Envelope. Details XHE. Details 1.0 ABIE XHE
3
^
XHEVersionID The version of the specific envelope model in use.
XHE_ Envelope. Version. Identifier 1 Identifier XHE. XHE Version Identifier. Identifier 1.0 BBIE XHE XHE Version Identifier XHE Version Identifier Identifier. Type
4
^
CustomizationID The identification of a customization or use of the envelope model.
XHE_ Envelope. Customization. Identifier 0..1 Identifier XHE. Customization Identifier. Identifier 1.0 BBIE XHE Customization Identifier Customization Identifier Identifier. Type
5
^
ProfileID The identification of a specific profile found within the customization.
XHE_ Envelope. Profile. Identifier 0..1 Identifier XHE. Profile Identifier. Identifier 1.0 BBIE XHE Profile Identifier Profile Identifier Identifier. Type
6
^
ProfileExecutionID The identification of a particular instance of using the given profile.
XHE_ Envelope. Profile Execution. Identifier 0..1 Identifier XHE. Profile Execution Identifier. Identifier 1.0 BBIE XHE Profile Execution Identifier Profile Execution Identifier Identifier. Type
7
^
Header Information relevant to the header/envelope itself, independent of the information it contains or references.
XHE_ Envelope. Metadata. XHE_ Document 1 Header XHE. Header 1.0 ASBIE XHE Header Header
8
^
Payloads The set of payloads.
XHE_ Envelope. Included. XHE_ Payload 0..1 Payloads XHE. Payloads 1.0 ASBIE XHE Payloads Payloads

XHE-CommonLibrary-1.0

This summary of elements only includes those members of the common library that are referenced directly or indirectly by ExchangeHeaderEnvelope.
Name CEFACT Dictionary Entry Name Card. Rep. Term Examples Dictionary Entry Name Ver. Comp.
Type
Class Prop. Term
Qualifier
Prop. Term
Poss. Noun
Prop. Term
Prim. Noun
Prop. Term Data Type Assoc.
Class
2 BusinessScope
<
Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
XHE_ Context. Details Business Scope. Details 1.0 ABIE Business Scope
3
^
BusinessScopeCriterion Internal specification of the scope and/or context of business.
XHE_ Context. Specified. XHE_ Parameter 0..n Business Scope Criterion Business Scope. Business Scope Criterion 1.0 ASBIE Business Scope Business Scope Criterion Business Scope Criterion
4
^
ExternalReference External documentation of the scope and/or context of business.
XHE_ Context. Scope. XHE_ Reference 0..n External Reference Business Scope. External Reference 1.0 ASBIE Business Scope External Reference External Reference
5 BusinessScopeCriterion
<
Documentation of one aspect of the scope of business or other contextual detail useful to understand the purpose of the envelope and its contents.
XHE_ Parameter. Details Business Scope Criterion. Details 1.0 ABIE Business Scope Criterion
6
^
BusinessScopeCriterionTypeCode Identifies the property of the scope by a code.
XHE_ Parameter. Type. Code 1 Code Business Scope Criterion. Business Scope Criterion Type. Code 1.0 BBIE Business Scope Criterion Business Scope Criterion Type Business Scope Criterion Type Code. Type
7
^
BusinessScopeCriterionValue Specifies the value of the given property.
XHE_ Parameter. Value. Text 1 Text Business Scope Criterion. Business Scope Criterion Value. Text 1.0 BBIE Business Scope Criterion Business Scope Criterion Value Business Scope Criterion Value Text. Type
8 ExternalReference
< < < < <
A reference to a business case, document or other issues which are relevant to the handling of the envelope.
XHE_ Reference. Details External Reference. Details 1.0 ABIE External Reference
9
^
ID Identifies the referenced object by some identifier or URI.
XHE_ Reference. Identification. Identifier 1 Identifier External Reference. Identifier 1.0 BBIE External Reference Identifier Identifier Identifier. Type
10
^
AvailabilityStartDateTime The start date and time when the information is available
XHE_ Reference. Start_ Availability. Date Time 0..1 Date Time External Reference. Availability Start Date Time. Date Time 1.0 BBIE External Reference Availability Start Date Time Availability Start Date Time Date Time. Type
11
^
AvailabilityEndDateTime The end date and time when the information is available
XHE_ Reference. End_ Availability. Date Time 0..1 Date Time External Reference. Availability End Date Time. Date Time 1.0 BBIE External Reference Availability End Date Time Availability End Date Time Date Time. Type
12
^
Login Text describing any login details to access the information.
XHE_ Reference. Login. Text 0..1 Text External Reference. Login. Text 1.0 BBIE External Reference Login Login Text. Type
13
^
Password A password needed to access the information.
XHE_ Reference. Password. Text 0..1 Text External Reference. Password. Text 1.0 BBIE External Reference Password Password Text. Type
14 Header
<
Information relevant to the header/envelope itself, independent of the information it contains or references.
XHE_ Document. Details Header. Details 1.0 ABIE Header
15
^
ID Unique ID of the envelope for tracking purposes.
XHE_ Document. Identification. Identifier 1 Identifier Header. Identifier 1.0 BBIE Header Identifier Identifier Identifier. Type
16
^
UUID An additional identifier of the envelope.
XHE_ Document. UUID. Identifier 0..1 Identifier Header. UUID. Identifier 1.0 BBIE Header UUID UUID Identifier. Type
17
^
CreationDateTime Date and time when the envelope was created.
XHE_ Document. Creation. Date Time 1 Date Time Header. Creation Date Time. Date Time 1.0 BBIE Header Creation Date Time Creation Date Time Date Time. Type
18
^
BusinessScope Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
XHE_ Document. Scope. XHE_ Context 0..1 Business Scope Europe vs Asia, Direct-to-Consumer vs Replenishment, or Prepaid vs Credit. Header. Business Scope 1.0 ASBIE Header Business Scope Business Scope
19
^
FromParty Information about the party that originated the envelope.
XHE_ Document. Sender. XHE_ Party 0..1 Party Header. From_ Party. Party 1.0 ASBIE Header From Party Party
20
^
ToParty Information about the parties to receive the envelope.
XHE_ Document. Recipient. XHE_ Party 1..n Party Header. To_ Party. Party 1.0 ASBIE Header To Party Party
21 Party
< <
The information about a party.
XHE_ Party. Details Party. Details 1.0 ABIE Party
22
^
PartyIdentification Unambiguous identifications of a party.
XHE_ Party. Specified. XHE_ Identity 1..n Party Identification Party. Party Identification 1.0 ASBIE Party Party Identification Party Identification
23 PartyIdentification
<
The information about a party's identification.
XHE_ Identity. Details Party Identification. Details 1.0 ABIE Party Identification
24
^
ID An unambiguous identification of a party.
XHE_ Identity. Identification. Identifier 1 Identifier Party Identification. Identifier 1.0 BBIE Party Identification Identifier Identifier Identifier. Type
25 Payload
<
The actual payload instance, such as a single invoice, conveyed within the envelope.
XHE_ Payload Instance. Details Payload. Details 1.0 ABIE Payload
26
^
ID A unique identification of this payload instance contained within the envelope.
XHE_ Payload Instance. Identification. Identifier 0..1 Identifier Payload. Identifier 1.0 BBIE Payload Identifier Identifier Identifier. Type
27
^
Description Text description of the payload instance.
XHE_ Payload Instance. Description. Text 0..n Text Payload. Description. Text 1.0 BBIE Payload Description Description Text. Type
28
^
DocumentTypeCode Identifies the abstract archetype of the payload instance.
XHE_ Payload Instance. Document_ Type. Code 0..1 Code Payload. Document Type Code. Code 1.0 BBIE Payload Document Type Code Document Type Code Code. Type
29
^
ContentTypeCode Identifies the file format or octet representation of the payload instance.
XHE_ Payload Instance. Content_ Type. Code 0..1 Code Payload. Content Type Code. Code 1.0 BBIE Payload Content Type Code Content Type Code Code. Type
30
^
CustomizationID Identifies the customization that applies to the payload instance.
XHE_ Payload Instance. Customization. Identifier 0..1 Identifier Payload. Customization Identifier. Identifier 1.0 BBIE Payload Customization Identifier Customization Identifier Identifier. Type
31
^
ProfileID Identifies the profile that the payload instance is part of.
XHE_ Payload Instance. Profile. Identifier 0..1 Identifier Payload. Profile Identifier. Identifier 1.0 BBIE Payload Profile Identifier Profile Identifier Identifier. Type
32
^
ProfileExecutionID Identifies the particular instance of an executing profile that the payload instance is part of.
XHE_ Payload Instance. Profile Execution. Identifier 0..1 Identifier Payload. Profile Execution Identifier. Identifier 1.0 BBIE Payload Profile Execution Identifier Profile Execution Identifier Identifier. Type
33
^
HandlingServiceID Identifies the service that should process the payload instance.
XHE_ Payload Instance. Handling Service. Identifier 0..1 Identifier Payload. Handling Service Identifier. Identifier 1.0 BBIE Payload Handling Service Identifier Handling Service Identifier Identifier. Type
34
^
ValidationTypeCode The type of the payload instance, used for the task of verifying that the grammar is valid.
XHE_ Payload Instance. Validation_ Type. Code 0..1 Code Payload. Validation Type Code. Code 1.0 BBIE Payload Validation Type Code Validation Type Code Code. Type
35
^
ValidationVersionID Descriptor containing version information of the validation type.
XHE_ Payload Instance. Validation Version. Identifier 0..1 Identifier Payload. Validation Version Identifier. Identifier 1.0 BBIE Payload Validation Version Identifier Validation Version Identifier Identifier. Type
36
^
InstanceEncryptionIndicator Indicator stating whether the payload instance is encrypted or not.
XHE_ Payload Instance. Encrypted. Indicator 1 Indicator Payload. Instance Encryption Indicator. Indicator 1.0 BBIE Payload Instance Encryption Indicator Instance Encryption Indicator Indicator. Type
37
^
InstanceEncryptionMethod Method used to encrypt the payload instance.
XHE_ Payload Instance. Encryption Method. Text 0..1 Text Payload. Instance Encryption Method. Text 1.0 BBIE Payload Instance Encryption Method Instance Encryption Method Text. Type
38
^
InstanceHashValue SHA-256 hash total of the unencrypted payload instance.
XHE_ Payload Instance. Encryption Hash Value. Text 0..1 Text Payload. Instance Hash Value. Text 1.0 BBIE Payload Instance Hash Value Instance Hash Value Text. Type
39
^
InstanceDecryptionInformationExternalReference Decryption information that is available external to the envelope.
XHE_ Payload Instance. Decryption. XHE_ Reference 0..1 External Reference Payload. Instance Decryption Information_ External Reference. External Reference 1.0 ASBIE Payload Instance Decryption Information External Reference External Reference
40
^
InstanceDecryptionKeyExternalReference Decryption key data that is available external to the envelope.
XHE_ Payload Instance. Decryption Key. XHE_ Reference 0..1 External Reference Payload. Instance Decryption Key_ External Reference. External Reference 1.0 ASBIE Payload Instance Decryption Key External Reference External Reference
41
^
RelevantExternalReference A reference to a business case, document or other issues which are relevant to the handling of the payload.
XHE_ Payload Instance. Relevant. XHE_ Reference 0..n External Reference Payload. Relevant_ External Reference. External Reference 1.0 ASBIE Payload Relevant External Reference External Reference
42
^
PayloadExternalReference The reference to the payload when it is not included within the envelope.
XHE_ Payload Instance. Payload. XHE_ Reference 0..1 External Reference Payload. Payload_ External Reference. External Reference 1.0 ASBIE Payload Payload External Reference External Reference
43 Payloads
<
The complete set of payloads.
XHE_ Payload. Details Payloads. Details 1.0 ABIE Payloads
44
^
Payload An individual payload within the set of payloads.
XHE_ Payload. Included. XHE_ Payload Instance 1..n Payload Payloads. Payload 1.0 ASBIE Payloads Payload Payload

Unqualified data types

Dict. Entry Name
(Base type XSD)
Content and supplementary components Cardi-
nality
Type
(XSD)
Definition
(property) (attribute)
Amount. Type
(xsd:decimal)

AmountContent A number of monetary units specified using a given unit of currency.
AmountCurrencyIdentifier currencyID required xsd:normalizedString The currency of the amount.
AmountCurrencyCodeListVersionIdentifier currencyCodeListVersionID optional xsd:normalizedString The VersionID of the UN/ECE Rec9 code list.
Binary Object. Type
(xsd:base64Binary)

BinaryObjectContent A set of finite-length sequences of binary octets.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the binary object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Graphic. Type
(xsd:base64Binary)

BinaryObjectContent A diagram, graph, mathematical curve, or similar representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the graphic object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Picture. Type
(xsd:base64Binary)

BinaryObjectContent A diagram, graph, mathematical curve, or similar representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the picture object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Sound. Type
(xsd:base64Binary)

BinaryObjectContent An audio representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the sound object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Video. Type
(xsd:base64Binary)

BinaryObjectContent A video representation.
BinaryObjectMimeCode mimeCode required xsd:normalizedString The mime type of the video object.
BinaryObjectCharacterSetCode characterSetCode optional xsd:normalizedString The character set of the binary object if the mime type is text.
BinaryObjectEncodingCode encodingCode optional xsd:normalizedString Specifies the decoding algorithm of the binary object.
BinaryObjectFilenameText filename optional xsd:string The filename of the binary object.
BinaryObjectFormatText format optional xsd:string The format of the binary content.
BinaryObjectUniformResourceIdentifier uri optional xsd:anyURI The Uniform Resource Identifier that identifies where the binary object is located.
Code. Type
(xsd:normalizedString)

< < < <
CodeContent A character string (letters, figures, or symbols) that for brevity and/or language independence may be used to represent or replace a definitive value or text of an attribute, together with relevant supplementary information.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the code name.
CodeListAgencyIdentifier listAgencyID optional xsd:normalizedString An agency that maintains one or more lists of codes.
CodeListAgencyNameText listAgencyName optional xsd:string The name of the agency that maintains the list of codes.
CodeListIdentifier listID optional xsd:normalizedString The identification of a list of codes.
CodeListNameText listName optional xsd:string The name of a list of codes.
CodeListSchemeUniformResourceIdentifier listSchemeURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the code list scheme is located.
CodeListUniformResourceIdentifier listURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the code list is located.
CodeListVersionIdentifier listVersionID optional xsd:normalizedString The version of the list of codes.
CodeNameText name optional xsd:string The textual equivalent of the code content component.
Date Time. Type
(xsd:dateTime)

DateTimeContent A particular point in the progression of time, together with relevant supplementary information.
Date. Type
(xsd:date)

DateContent One calendar day according the Gregorian calendar.
Time. Type
(xsd:time)

TimeContent An instance of time that occurs every day.
Identifier. Type
(xsd:normalizedString)

< < < < < < < < < < < < < <
IdentifierContent A character string to identify and uniquely distinguish one instance of an object in an identification scheme from all other objects in the same scheme, together with relevant supplementary information.
IdentificationSchemeAgencyIdentifier schemeAgencyID optional xsd:normalizedString The identification of the agency that maintains the identification scheme.
IdentificationSchemeAgencyNameText schemeAgencyName optional xsd:string The name of the agency that maintains the identification scheme.
IdentificationSchemeDataUniformResourceIdentifier schemeDataURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the identification scheme data is located.
IdentificationSchemeIdentifier schemeID optional xsd:normalizedString The identification of the identification scheme.
IdentificationSchemeNameText schemeName optional xsd:string The name of the identification scheme.
IdentificationSchemeUniformResourceIdentifier schemeURI optional xsd:anyURI The Uniform Resource Identifier that identifies where the identification scheme is located.
IdentificationSchemeVersionIdentifier schemeVersionID optional xsd:normalizedString The version of the identification scheme.
Indicator. Type
(xsd:boolean)

<
IndicatorContent A list of two mutually exclusive Boolean values that express the only possible states of a property.
Measure. Type
(xsd:decimal)

MeasureContent A numeric value determined by measuring an object using a specified unit of measure.
MeasureUnitCode unitCode required xsd:normalizedString The type of unit of measure.
MeasureUnitCodeListVersionIdentifier unitCodeListVersionID optional xsd:normalizedString The version of the measure unit code list.
Numeric. Type
(xsd:decimal)

NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Value. Type
(xsd:decimal)

NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Percent. Type
(xsd:decimal)

NumericContent Numeric information that is assigned or is determined by calculation, counting, or sequencing and is expressed as a percentage. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Rate. Type
(xsd:decimal)

NumericContent A numeric expression of a rate that is assigned or is determined by calculation, counting, or sequencing. It does not require a unit of quantity or unit of measure.
NumericFormatText format optional xsd:string Whether the number is an integer, decimal, real number or percentage.
Quantity. Type
(xsd:decimal)

QuantityContent A counted number of non-monetary units, possibly including a fractional part.
QuantityUnitCode unitCode optional xsd:normalizedString The unit of the quantity
QuantityUnitCodeListAgencyIdentifier unitCodeListAgencyID optional xsd:normalizedString The identification of the agency that maintains the quantity unit code list
QuantityUnitCodeListAgencyNameText unitCodeListAgencyName optional xsd:string The name of the agency which maintains the quantity unit code list.
QuantityUnitCodeListIdentifier unitCodeListID optional xsd:normalizedString The quantity unit code list.
Text. Type
(xsd:string)

< < < < < <
TextContent A character string (i.e. a finite set of characters), generally in the form of words of a language.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the content component.
LanguageLocaleIdentifier languageLocaleID optional xsd:normalizedString The identification of the locale of the language.
Name. Type
(xsd:string)

TextContent A character string that constitutes the distinctive designation of a person, place, thing or concept.
LanguageIdentifier languageID optional xsd:language The identifier of the language used in the content component.
LanguageLocaleIdentifier languageLocaleID optional xsd:normalizedString The identification of the locale of the language.

Summary

Copyright © UN/CEFACT; Copyright © OASIS Open

Rendering: 20190506-0130z

Legends: Summary Legend: Name (Model line Object) TYPE Description
Table Legend: ^ = up-link to the containing ABIE of the BBIE or the ASBIE (hover to see ABIE name)
< = back-link to the ASBIE using the ABIE, or to the BBIE using the data type (hover to see destination)
Line number links: alternate between summary view and table view

AVA

AvailabilityEndDateTime (11 ExternalReference) BBIE The end date and time when the information is available
AvailabilityStartDateTime (10 ExternalReference) BBIE The start date and time when the information is available

BUS

BusinessScope

    

XHE-CommonLibrary-1.0

    

(2) ABIE Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
(18 Header) ASBIE Documentation of the scope of business or other contextual details useful to understand the purpose of the envelope and its contents.
BusinessScopeCriterion

    

XHE-CommonLibrary-1.0

    

(5) ABIE Documentation of one aspect of the scope of business or other contextual detail useful to understand the purpose of the envelope and its contents.
(3 BusinessScope) ASBIE Internal specification of the scope and/or context of business.
BusinessScopeCriterionTypeCode (6 BusinessScopeCriterion) BBIE Identifies the property of the scope by a code.
BusinessScopeCriterionValue (7 BusinessScopeCriterion) BBIE Specifies the value of the given property.

CON

ContentTypeCode (29 Payload) BBIE Identifies the file format or octet representation of the payload instance.

CRE

CreationDateTime (17 Header) BBIE Date and time when the envelope was created.

CUS

CustomizationID

    

ExchangeHeaderEnvelope (4 XHE) BBIE The identification of a customization or use of the envelope model.
XHE-CommonLibrary-1.0 (30 Payload) BBIE Identifies the customization that applies to the payload instance.

DES

Description (27 Payload) BBIE Text description of the payload instance.

DOC

DocumentTypeCode (28 Payload) BBIE Identifies the abstract archetype of the payload instance.

EXT

ExternalReference

    

XHE-CommonLibrary-1.0

    

(8) ABIE A reference to a business case, document or other issues which are relevant to the handling of the envelope.
InstanceDecryptionInformationExternalReference (39 Payload) InstanceDecryptionKeyExternalReference (40 Payload) PayloadExternalReference (42 Payload) RelevantExternalReference (41 Payload)
(4 BusinessScope) ASBIE External documentation of the scope and/or context of business.

FRO

FromParty (19 Header) ASBIE (Party) Information about the party that originated the envelope.

HAN

HandlingServiceID (33 Payload) BBIE Identifies the service that should process the payload instance.

HEA

Header

    

ExchangeHeaderEnvelope (7 XHE) ASBIE Information relevant to the header/envelope itself, independent of the information it contains or references.
XHE-CommonLibrary-1.0 (14) ABIE Information relevant to the header/envelope itself, independent of the information it contains or references.

ID

ID

    

XHE-CommonLibrary-1.0

    

(9 ExternalReference) BBIE Identifies the referenced object by some identifier or URI.
(15 Header) BBIE Unique ID of the envelope for tracking purposes.
(24 PartyIdentification) BBIE An unambiguous identification of a party.
(26 Payload) BBIE A unique identification of this payload instance contained within the envelope.

INS

InstanceDecryptionInformationExternalReference (39 Payload) ASBIE (ExternalReference) Decryption information that is available external to the envelope.
InstanceDecryptionKeyExternalReference (40 Payload) ASBIE (ExternalReference) Decryption key data that is available external to the envelope.
InstanceEncryptionIndicator (36 Payload) BBIE Indicator stating whether the payload instance is encrypted or not.
InstanceEncryptionMethod (37 Payload) BBIE Method used to encrypt the payload instance.
InstanceHashValue (38 Payload) BBIE SHA-256 hash total of the unencrypted payload instance.

LOG

Login (12 ExternalReference) BBIE Text describing any login details to access the information.

PAR

Party (21) ABIE The information about a party.
FromParty (19 Header) ToParty (20 Header)
PartyIdentification

    

XHE-CommonLibrary-1.0

    

(23) ABIE The information about a party's identification.
(22 Party) ASBIE Unambiguous identifications of a party.

PAS

Password (13 ExternalReference) BBIE A password needed to access the information.

PAY

Payload

    

XHE-CommonLibrary-1.0

    

(25) ABIE The actual payload instance, such as a single invoice, conveyed within the envelope.
(44 Payloads) ASBIE An individual payload within the set of payloads.
PayloadExternalReference (42 Payload) ASBIE (ExternalReference) The reference to the payload when it is not included within the envelope.
Payloads

    

ExchangeHeaderEnvelope (8 XHE) ASBIE The set of payloads.
XHE-CommonLibrary-1.0 (43) ABIE The complete set of payloads.

PRO

ProfileExecutionID

    

ExchangeHeaderEnvelope (6 XHE) BBIE The identification of a particular instance of using the given profile.
XHE-CommonLibrary-1.0 (32 Payload) BBIE Identifies the particular instance of an executing profile that the payload instance is part of.
ProfileID

    

ExchangeHeaderEnvelope (5 XHE) BBIE The identification of a specific profile found within the customization.
XHE-CommonLibrary-1.0 (31 Payload) BBIE Identifies the profile that the payload instance is part of.

REL

RelevantExternalReference (41 Payload) ASBIE (ExternalReference) A reference to a business case, document or other issues which are relevant to the handling of the payload.

TOP

ToParty (20 Header) ASBIE (Party) Information about the parties to receive the envelope.

UUI

UUID (16 Header) BBIE An additional identifier of the envelope.

VAL

ValidationTypeCode (34 Payload) BBIE The type of the payload instance, used for the task of verifying that the grammar is valid.
ValidationVersionID (35 Payload) BBIE Descriptor containing version information of the validation type.

XHE

XHE (2) ABIE The Exchange Header Envelope
XHEVersionID (3 XHE) BBIE The version of the specific envelope model in use.




END