Documentation Index

Fetch the complete documentation index at: https://support.lusid.com/llms.txt

Use this file to discover all available pages before exploring further.

Understanding instrument lifecycle events emitted by LUSID

  • Updated on Jul 24, 2026
  • Published on Aug 20, 2024
Prev Next

LUSID can emit lifecycle events for supported term instruments, enabling you to handle those events in a seamless and consistent manner.

Important: To enable instrument events, register a recipe with every portfolio you wish events to impact. More information.

For example, LUSID automatically emits a BondCouponEvent each time a bond coupon is due. No user input is required, providing you have mastered the underlying instrument as either type Bond, ComplexBond or InflationLinkedBond in the LUSID Security Master. In addition:

  • LUSID provides a BondCouponEvent default transaction template that automatically generates a transaction representing each coupon amount on its ex-date. You can override this default template if you wish, but it is not necessary.

  • You must implement a BondCoupon transaction type to confer a suitable economic impact on automatically-generated bond coupon transactions. We provide a recommendation, which you can either implement as-is or change if desired.

Note: Instruments of type Equity do not have a lifecycle in the normal sense but you can load a stream of corporate actions and trigger LUSID to emit appropriate events. More information.

With the BondCoupon transaction type in place, for each portfolio with a holding in the bond instrument on the ex-date of each coupon, LUSID automatically:

  1. Generates an output transaction scaled to your holding in that portfolio, and enriched with extra information such as gain/loss or a tax calculation.

  2. Implements the economic impact prescribed by the transaction type, for example adding the bond coupon amount to a particular cash balance.

Note: If an event does not generate an output transaction, the issue usually relates to transaction type scopes and sources. Troubleshooting guide.

Bond, ComplexBond and InflationLinkedBond (but not MBS)

Recommended reading: Handling bond coupon, principal and maturity events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

BondCouponEvent

✅ Can also be manually loaded

✅

BondCoupon

BondDefaultEvent

❌ Must be manually loaded

❌

N/A

BondPrincipalEvent

✅ Can also be manually loaded

✅

BondPrincipal

ConsentEvent (not ILB)

❌ Must be manually loaded

✅

ConsentAccept

ConversionEvent

❌ Must be manually loaded

✅

DrawingEvent (not ILB)

❌ Must be manually loaded

✅

BondDrawing

DutchAuctionEvent (not ILB)

❌ Must be manually loaded

✅

  • DutchAuctionRemoveExisting

  • DutchAuctionReceiveUnits

  • DutchAuctionCashSettlement

  • DutchAuctionCashInLieu

EarlyRedemptionEvent

❌ Must be manually loaded

✅

ExchangeOfferEvent (not ILB)

❌ Must be manually loaded

✅

  • ExchangeRemoveExisting

  • ExchangeReceiveUnits

  • ExchangeCashInLieu

  • ExchangeReceiveCash

InterestPaymentEvent

❌ Must be manually loaded

✅

InterestPayment

LiquidationPaymentEvent (not ILB)

❌ Must be manually loaded

✅

  • LiquidationCash

  • LiquidationCashFinal

MaturityEvent

✅

✅

Maturity

PariPassuEvent

❌ Must be manually loaded

✅

  • PariPassuAssimilationDebit

  • PariPassuAssimilationCredit

PutRedemptionEvent

❌ Must be manually loaded

✅

RepurchaseOfferEvent

❌ Must be manually loaded

✅

  • RepurchaseOfferEventChooseCash

  • RepurchaseOfferEventCashAccrued

  • RepurchaseOfferEventChooseTender

  • RepurchaseOfferEventTenderAccrued

SecurityWriteOffEvent (not ILB)

❌ Must be manually loaded

✅

Worthless

SpinOffEvent

❌ Must be manually loaded

✅

  • SpinOffAdjustCost

  • SpinOffNewUnits

  • SpinOffCashInLieu

TenderEvent

❌ Must be manually loaded

✅

  • TenderRemoveExisting

  • TenderAdjustCost

  • TenderReceiveCash

  • TenderReceiveUnits

  • TenderCashInLieu

  • TenderEventCashAccrued

WorthlessEvent (not ILB)

❌ Must be manually loaded

✅

Worthless

MBS (modelled as a ComplexBond)

To convert, default or redeem an MBS early, contact Technical Support.

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

MbsCouponEvent

✅

✅

MbsCoupon

MbsInterestDeferralEvent

✅

✅

MbsInterestDeferral

MbsInterestShortfallEvent

✅

✅

MbsInterestShortfall

MbsPrincipalEvent

✅

✅

MbsPrincipal

MbsPrincipalWriteOffEvent

✅

✅

MbsPrincipalWriteOff

MaturityEvent

✅

✅

Maturity

CdsIndex and CreditDefaultSwap

Recommended reading: Handling premium, credit and maturity events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

CreditPremiumCashFlowEvent

✅

✅

CreditPremiumCashFlow

MaturityEvent

✅

✅

Maturity

ProtectionPayoutCashFlowEvent

❌ Triggered by loading CdxCreditEvent or CdsCreditEvent

✅

ProtectionPayoutCashFlow

EquityOption, ExchangeTradedOption and InterestRateSwaption

Recommended reading: Handling exercise or expiry events

Note for an ETO the underlying must be an Equity or Future. Other underlyings do not support instrument events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

OptionExerciseCashEvent

(if cash-settled)

❌ Triggered by event instruction

✅

CashSettledOptionExercise

OptionExercisePhysicalEvent

(if physically-settled)

❌ Triggered by event instruction

✅

MergerEvent
(EquityOption only)

❌ Must be manually loaded

✅

  • MergerRemoveExisting

  • MergerAdjustCost

  • MergerReceiveCash

  • MergerReceiveUnits

  • MergerCashInLieu

ExpiryEvent

✅ Only if unexercised

✅ Only if unexercised

Expiry

WarrantsExerciseEvent (EquityOption only)

❌ Must be manually loaded

✅

  • WarrantExercise

  • WarrantSurrender

  • WarrantLapse

FlexibleRepo

Recommended reading: Handling cashflow, collateral, payment and closure events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

FlexibleRepoCashFlowEvent

✅

✅

FlexibleRepoCashTransfer

FlexibleRepoCollateralEvent

✅

✅

FlexibleRepoCollateralTransfer

FlexibleRepoInterestPaymentEvent

✅

✅

FlexibleRepoInterestPayment

FlexibleRepoFullClosureEvent

❌ Must be manually loaded

❌

N/A

FlexibleRepoPartialClosureEvent

❌ Must be manually loaded

❌

N/A

MaturityEvent

✅

✅

Maturity

Future

Recommended reading: Handling mark to market and expiry events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

FutureMarkToMarketEvent

✅

✅

FutureMarkToMarket

FutureExpiryEvent

✅

✅

FutureCashSettlement

FxForward

Recommended reading: Handling settlement and close out events for deliverable forwards

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

FxForwardSettlementEvent

✅

✅

EarlyCloseOutEvent

❌ Must be manually loaded

✅

EarlyCloseOutSettlement

MaturityEvent

✅

✅

Maturity

InterestRateSwap

Recommended reading: Handling cashflow and principal events

Lifecycle event

Automatically emitted by LUSID?

Event generates output transactions?

Transaction types requiring implementation

SwapCashFlowEvent

✅

✅

SwapCashFlow

SwapPrincipalEvent

✅

✅

SwapPrincipal

MaturityEvent

✅

✅

Maturity

Other instrument types

LUSID instrument type

Lifecycle event

Automatically emitted by LUSID?

Event generates transactions?

Transaction types requiring implementation

CapFloor

CapletFloorletCashFlowEvent

✅

✅

CapletFloorletCashFlow

MaturityEvent

✅

✅

Maturity

ContractForDifference

MaturityEvent

✅

✅

Maturity

EquitySwap

MaturityEvent

✅

✅

Maturity

FlexibleDeposit

DepositInterestPaymentEvent

✅

✅

  • DepositInterestPayment

  • DepositInterestPaymentBalanceAdjustment

UpdateDepositAmountEvent

❌ Must be manually loaded

✅

UpdateDepositAmount

DepositRollEvent

❌ Must be manually loaded

✅

  • DecreaseBalance

  • IncreaseBalance

  • WithdrawInterest

  • ReinvestInterest

DepositCloseEvent

❌ Must be manually loaded

✅

  • DepositCloseInterestPayment

  • DepositCloseFinalBalanceRepayment

  • DepositClose

FlexibleLoan

LoanInterestRepaymentEvent

✅ Can also be manually loaded

✅

LoanInterestRepayment

LoanPrincipalRepaymentEvent

✅ Can also be manually loaded

✅

  • LoanBalanceReduction

  • LoanLimitReduction

  • TermLoanFacilityLimitDecrease

  • RevolvingLoanFacility

ForwardRateAgreement

MaturityEvent

✅

✅

Maturity

FxSwap

FxForwardSettlementEvent

✅

✅

FxForwardPrincipal

MaturityEvent

✅

✅

Maturity

InflationSwap

SwapCashFlowEvent

✅

✅

SwapCashFlow

MaturityEvent

✅

✅

Maturity

LoanFacility

ContractInitialisationEvent

❌ Must be manually loaded

✅

InitialiseContract

AdjustGlobalCommitmentEvent

❌ Must be manually loaded

✅

AdjustGlobalCommitment

DrawdownEvent

❌ Must be manually loaded

✅

  • DrawdownFacilityBalance

  • IncreaseContractBalance

LoanInterestRepaymentEvent

✅ Can also be manually loaded

✅

LoanInterestRepayment

LoanFacilityContractRolloverEvent

❌ Must be manually loaded

❌

N/A

LoanPrincipalRepaymentEvent

✅ Can also be manually loaded

✅

  • LoanBalanceReduction

  • LoanLimitReduction

  • TermLoanFacilityLimitDecrease

  • RevolvingLoanFacility

LoanFacilityDelayedCompensationPaymentEvent

❌ Must be manually loaded

✅

LoanFacilityDelayedCompensationPayment

TermDeposit

TermDepositInterestEvent

✅

✅

TermDepositInterest

TermDepositPrincipalEvent

✅

✅

TermDepositPrincipal

MaturityEvent

✅

✅

Maturity

TotalReturnSwap

MaturityEvent

✅

✅

Maturity

© 2025 FINBOURNE Technology