Skip to main content

Transmission

The Transmission entity tracks inbound and outbound message exchanges (EDI, API calls, webhooks, emails, etc.) associated with orders. It provides a complete audit trail of all communication events, including retry logic, error tracking, and payload references.

Transmissions are linked to orders through the OrderTransmission join entity, supporting a many-to-many relationship — a single transmission can span multiple orders, and each order can have many transmissions.

Fields

Field NameTypeMax LengthRequiredDefaultDescription
TransmissionIdInt32AutoAuto-incrementPrimary key
OrganizationIdInt32YesOrganization scope
CorrelationIdGuidYesNewGuid()Groups related transmissions together
ParentIdInt32?NoSelf-referential FK for parent/child chains
ChannelString20YesCommunication channel (e.g. EDI, API, EMAIL, WEBHOOK)
DirectionTransmissionDirectionYesInbound (0) or Outbound (1)
MessageTypeString?50NoMessage type identifier (e.g. 204, 990, 214)
SenderString?100NoSender identifier
ReceiverString?100NoReceiver identifier
StatusTransmissionStatus?NoCurrent transmission status
EndpointString?500NoTarget URL or endpoint address
ProtocolString?20NoProtocol (e.g. HTTPS, SFTP, AS2)
HttpStatusInt16?NoHTTP response status code
ByteSizeInt32?NoPayload size in bytes
RetryCountInt16Yes0Current retry attempt
MaxRetriesInt16Yes3Maximum retry attempts
NextRetryAtDateTime?NoScheduled next retry time
ErrorCodeString?50NoError code for failures
ErrorMessageString?NoError description
CustomValuesDictionary?— (JSONB)NoArbitrary key-value metadata
HeadersDictionary?— (JSONB)NoMessage headers
PayloadRefString?NoReference to stored payload (e.g. blob URI)
ScheduledAtDateTime?NoWhen the transmission was scheduled
StartedAtDateTime?NoWhen processing started
CompletedAtDateTime?NoWhen processing completed
DurationMsInt32?NoProcessing duration in milliseconds
IsDeletedBooleanYesfalseSoft-delete flag (filtered by default)
CreatedDateTimeAutoCreated timestamp
CreatedByString36AutoCreated by user ID
LastModifiedDateTimeAutoLast modified timestamp
LastModifiedByString36AutoLast modified by user ID

Enums

TransmissionDirection

ValueNameDescription
0InboundMessage received from external source
1OutboundMessage sent to external destination

TransmissionStatus

ValueNameDescription
0PendingQueued, not yet processed
1InProgressCurrently being processed
2SentSuccessfully sent (outbound)
3ReceivedSuccessfully received (inbound)
4DeliveredConfirmed delivery at destination
5AcknowledgedFunctional acknowledgment received
6RejectedRejected by receiver
7ErrorProcessing error occurred
8RetryScheduledFailed, retry scheduled
9CancelledManually or automatically cancelled
10ExpiredExceeded retry window

Relationships

RelationshipTarget EntityTypeDescription
OrganizationOrganizationMany-to-OneOrganization scope
ParentTransmissionMany-to-One (self)Parent transmission for chains
ChildrenTransmission[]One-to-Many (self)Child transmissions
OrderTransmissionsOrderTransmission[]One-to-ManyJoin table linking to orders

OrderTransmission (Join Entity)

Field NameTypeDescription
OrderIdInt32FK to Order
TransmissionIdInt32FK to Transmission

Database Indexes

IndexColumn(s)Purpose
IX_Transmissions_CorrelationIdCorrelationIdFast lookup of correlated messages
IX_Transmissions_OrganizationIdOrganizationIdOrg-scoped queries
IX_Transmissions_StatusStatusFilter by status
IX_Transmissions_ChannelChannelFilter by channel
IX_Transmissions_ParentIdParentIdParent/child traversal

Views

OrderTransmissionSummaryView (vw_order_transmission_summary)

Pre-aggregated summary per order, available via GraphQL as transmissionsSummary on the Order type.

FieldTypeDescription
OrderIdInt32Order ID
OrganizationIdInt32Organization ID
TotalCountInt32Total transmissions for this order
HasAnyBooleanWhether the order has any transmissions
LatestCreatedDateTime?Most recent transmission timestamp
LatestChannelString?Channel of latest transmission
LatestStatusString?Status of latest transmission