MtxEvent

Table 1. Parameters
Name	Data Type	Description
InitiatorId	object id	OID of subscriber or group that initiated the event.
InitiatorExternalId	string	External ID of subscriber or group that initiated the event.
InitiatorDeviceId	object id	No Description
InitiatorDeviceExternalId	string	No Description
Flags	unsigned int32	0x01 = Initiator is group. 0x02 = Notify 0x04 = Wallet owner is group.
WalletId	object id	No Description
WalletOwnerId	object id	OID of subscriber or group that owns the wallet.
WalletOwnerExternalId	string	External ID of subscriber or group that owns the wallet.
TaxStatus	unsigned int32	Tax status.
TaxCertificate	string	Tax certificate.
TaxLocation	string	The locale under whose jurisdiction tax status is defined. Conceptually this is an ISO country code string but this will not be enforced.
BalanceUpdateArray	array of MtxBalanceUpdate	No Description
ChargeList	list of MtxEventCharge	No Description
EventTime	datetime	No Description
Duration	unsigned int64	Event duration in microseconds
EventId	string	Unique identifier of the event.
GlDate	date	GL posting date.
GlInfoArray	array of MtxEventGlInfo	Array of records storing GL info for event.
GlCenter	string	Line-of-business.
PaymentAuthEventId	string	Set only if event includes a pay-now balance update. Value is the ID of the corresponding payment authorization event.
DeleteCode	unsigned int8	Value specifies when event can be deleted from external event store. Value and there meanings are determined by operator.
BalanceStateUpdateArray	array of MtxBalanceStateUpdate	No Description
GlVersionId	unsigned int16	The version of GL used to generate the records in GlInfoArray. It is set only if GL Info is to be included in events. If it is not set and GL Info is in events, then GL version is assumed to be 1.
InitiatorPrimaryUserId	object id	OID of user owner if initiator has an owner.
InitiatorPrimaryUserExternalId	string	External ID of user owner if initiator has an owner.
InitiatorType	unsigned int16 (enum)	Type of the object that initiated the event. "subscription" (1) "group" (2) "user" (3) "device" (4)
WalletOwnerType	unsigned int16 (enum)	Type of the object that owns the wallet. "subscription" (1) "group" (2)
StreamCursor	string	For use by the stream server.
CarrierChargeList	list of MtxEventCharge	The charges that will be paid by carrier.
TenantId	string	Unique ID selected by the service provider to uniquely identify the Tenant across all domains. Only values within an existing MtxTenantProfile may be used. May not be changed once set.
LocationGeoCode	string	Geographical code.
CustomerType	string	Tax customer type for selecting taxes from Tax database.
TaxOnTaxChargeList	list of MtxEventCharge	The tax-on-tax charges list. The amount is included in ChargeList. No balance impact.
Version	unsigned int16	Version of event. Always 1 during original processing. Can be higher if event is produced during rerating. This field is set only if rerating is enabled.
TxnEventId	string	Id of associated transaction event. Set if rerating is enabled. Not set in a transaction event.
TxnEventVersion	unsigned int16	Version of associated transaction event. Set if rerating is enabled. Not set in a transaction event.
IsDeleted	bool	Set only if rerating is enabled. Rerating generates events with this field set to true (1) to indicate that a billing system should consider the previous version of the event (either from original processing or from previous rerating) to be deleted.
ReratingJobId	unsigned int64	Set only during rerating. ID of rerating job in which event was produced.
SubDomainId	unsigned int16	Set in events from live system if rerating is enabled. ID of subdomain generating event. Not set in events from rerating.
UniqueSequenceId	unsigned int64	Unique sequence id, one for business events (i.e. MDC is descend of either primary or secondary event) and the other for internal events.

InitiatorId

object id

OID of subscriber or group that initiated the event.

InitiatorExternalId

string

External ID of subscriber or group that initiated the event.

InitiatorDeviceId

object id

No Description

InitiatorDeviceExternalId

string

No Description

Flags

unsigned int32

0x01 = Initiator is group. 0x02 = Notify 0x04 = Wallet owner is group.

WalletId

object id

No Description

WalletOwnerId

object id

OID of subscriber or group that owns the wallet.

WalletOwnerExternalId

string

External ID of subscriber or group that owns the wallet.

TaxStatus

unsigned int32

Tax status.

TaxCertificate

string

Tax certificate.

TaxLocation

string

The locale under whose jurisdiction tax status is defined. Conceptually this is an ISO country code string but this will not be enforced.

BalanceUpdateArray

array of MtxBalanceUpdate

No Description

ChargeList

list of MtxEventCharge

No Description

EventTime

datetime

No Description

Duration

unsigned int64

Event duration in microseconds

EventId

string

Unique identifier of the event.

GlDate

date

GL posting date.

GlInfoArray

array of MtxEventGlInfo

Array of records storing GL info for event.

GlCenter

string

Line-of-business.

PaymentAuthEventId

string

Set only if event includes a pay-now balance update. Value is the ID of the corresponding payment authorization event.

DeleteCode

unsigned int8

Value specifies when event can be deleted from external event store. Value and there meanings are determined by operator.

BalanceStateUpdateArray

array of MtxBalanceStateUpdate

No Description

GlVersionId

unsigned int16

The version of GL used to generate the records in GlInfoArray. It is set only if GL Info is to be included in events. If it is not set and GL Info is in events, then GL version is assumed to be 1.

InitiatorPrimaryUserId

object id

OID of user owner if initiator has an owner.

InitiatorPrimaryUserExternalId

string

External ID of user owner if initiator has an owner.

InitiatorType

unsigned int16 (enum)

Type of the object that initiated the event.

"subscription" (1)
"group" (2)
"user" (3)
"device" (4)

WalletOwnerType

unsigned int16 (enum)

Type of the object that owns the wallet.

"subscription" (1)
"group" (2)

StreamCursor

string

For use by the stream server.

CarrierChargeList

list of MtxEventCharge

The charges that will be paid by carrier.

TenantId

string

Unique ID selected by the service provider to uniquely identify the Tenant across all domains. Only values within an existing MtxTenantProfile may be used. May not be changed once set.

LocationGeoCode

string

Geographical code.

CustomerType

string

Tax customer type for selecting taxes from Tax database.

TaxOnTaxChargeList

list of MtxEventCharge

The tax-on-tax charges list. The amount is included in ChargeList. No balance impact.

Version

unsigned int16

Version of event. Always 1 during original processing. Can be higher if event is produced during rerating. This field is set only if rerating is enabled.

TxnEventId

string

Id of associated transaction event. Set if rerating is enabled. Not set in a transaction event.

TxnEventVersion

unsigned int16

Version of associated transaction event. Set if rerating is enabled. Not set in a transaction event.

IsDeleted

bool

Set only if rerating is enabled. Rerating generates events with this field set to true (1) to indicate that a billing system should consider the previous version of the event (either from original processing or from previous rerating) to be deleted.

ReratingJobId

unsigned int64

Set only during rerating. ID of rerating job in which event was produced.

SubDomainId

unsigned int16

Set in events from live system if rerating is enabled. ID of subdomain generating event. Not set in events from rerating.

UniqueSequenceId

unsigned int64

Unique sequence id, one for business events (i.e. MDC is descend of either primary or secondary event) and the other for internal events.