xml COMEVE (Communication Event)

The Communication Event message intent is to exchange information related to

General usage

- The message includes functionality

Name Required Description Examples Xpath Type Limits Sort Id
Ref ID

The senders Reference number/ID for the specific communication event message.

 <communicationEvent refId="3231224056"> 
/b24Message/communicationEvent/@refId Number 100 1
Message Class

Text by sender referenced message class such as PRICAT, ORDERS, ORDRSP, DESADV, INVOIC etc.

 <communicationEvent messageClass="INVOIC"> 
/b24Message/communicationEvent/@messageClass Text 200 2
Outcome (Header Level)

The by sender communicated outcome of the referred messages in the communication event. Predefined values: Received, Delivered,
Validated, OnHold, Discarded, NotReceived.

 <communicationEvent outcome="Received"> 
/b24Message/communicationEvent/@outcome Text 300 3
Severity

The by sender communicated severity of the messages - e.g. Information, Warning, Error or omitted completely

 <communicationEvent outcome="Information"> 
/b24Message/communicationEvent/@severity Text 400 4
Btwentyfour Message ID

Message ID set by Btwentyfour Omnichannel Platform

 <communicationEvent messageId="237357"> 
/b24Message/communicationEvent/@messageId Number 500 5
Btwentyfour Message Date

Message date set by Btwentyfour Omnichannel Platform

 <communicationEvent messageDate="2022-05-14T12:19:05.167Z"> 
/b24Message/communicationEvent/@messageDate Date/Time 600 6
EDI Message Name

The name of the EDI message

 <communicationEvent text="Btwentyfour Example Communication Event"> 
/b24Message/communicationEvent/@text Text 700 7
Environment

Environment/test indicator - either "Production" or "Test"

 <communicationEvent text="Btwentyfour Example Communication Event" environment="Test"> 
/b24Message/communicationEvent/@environment Text 800 8
Sender Yes

The sender of the EDI message, identified by a GLN

 <sender gln="7340117836950"> 
/b24Message/communicationEvent/sender/@gln Number 900 9
Recipient Yes

The recipient of the EDI message, identified by a GLN

 <recipient gln="7340117815580"> 
/b24Message/communicationEvent/recipient/@gln Number 1000 10
The Document Reference ID

The document type and the ID/number identifying the referenced document. This example refers to an invoice number

 <documentReference documentType="Invoice" id="1988744"> 
/b24Message/communicationEvent/documentReference[@documentType="Invoice"]/@id Text 1100 11
The Document Reference Date

The date of the referenced document. This example refers to an invoice date.

 <documentReference documentType="Invoice" id="23554" date="2022-05-11"> 
/b24Message/communicationEvent/documentReference[@documentType="Invoice"]/@date Date/Time 1200 12
Outcome (Detailed Document Level)

The by sender communicated outcome for the specific message documentReference/ID. Outcome "Accepted" - as an example the invoice is accepted (invoice is received and imported)
Outcome "Rejected" – invoice not accepted.

 <property name="outcome">Accepted</property> 
/b24Message/communicationEvent/documentReference/property[@name="outcome"] Text 1300 13