Table Description
Financial Instruction: A credit or debit transaction relating to a participant.

Each financial instruction represents a rolled-up view of one or more instruction line items (ILIs). 'Rolling up' is the process of amalgamating a number of ILIs of the same category, status, deliveryMethod, currencyType, caseNomineeID and concernRoleID in order to create one financial instruction.

The resultant type of the financial instruction depends on the category of its constituent ILIs. ILIs are rolled-up to create either payments or liabilities, depending on the ILIs' category, to be issued to particular participants or case nominees.

A rolled-up financial instruction generates a payment instruction or liability instruction (depending on the financial instruction type), which in turn is used in the issuing of payment instruments and liability instruments.

Rolling up prevents multiple payments/liabilities and financial advice notices being issued for every product component payable/billable to a participant or case nominee.

Example

When a utility company is being paid, creating a payment for every utility deduction created on a participant or case nominee account is not desirable as this would result in multiple checks being issued.

The utility is only interested in receiving a check for the total amount deducted from one or more accounts over a certain period of time.

Relationship Diagram
Click the diagram to manipulate and zoom. Traverse the diagram using Click-and-Drag motions.
Model Details
Location in Model: Logical View::MetaModel::Curam::Core::Reference Model::Financial::Entity Objects::FinancialInstruction::FinancialInstruction
Controlling File: core\model\Packages\Financial Manager Packages\FinancialInstruction_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
LAST_UPDATED_FIELDyes
Attributes (12)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
finInstructionIDkeynoUnique reference number assigned by the system to a Financial Instruction recordFINANCIAL_INSTRUCTION_ID SVR_INT64
typeCodedetails Code value to denote the type of the Financial Instruction. Populated from the FinancialInstruction code table.FINANCIAL_INSTRUCTION_CODEFinancialInstructionSVR_STRING<10>
concernRoleIDdetailsnoconcernRoleID for the ConcernRole in respect of which this FinancialInstruction was issuedCONCERN_ROLE_ID SVR_INT64
statusCodedetails Code value to indicate the current status of the Financial Instruction. Populated from the FinancialInstructionStatus code table.FIN_INSTRUCTION_STATUS_CODEFinInstructionStatusSVR_STRING<10>
amountdetails A financial amount associated with the Financial Instruction. 'This consists of the total of the Instruction Line Items associated with the Financial Instruction ID.CURAM_AMOUNT SVR_MONEY
effectiveDatedetails Date Financial Instruction is valid from.CURAM_DATE SVR_DATE
postingDatedetails Creation Date of the Financial Instruction on the system. 'Date on which the Financial Instruction is 'Posted' to the Concern Role Account.CURAM_DATE SVR_DATE
creditDebitTypedetails Code value to indicate whether the Instruction/Line Item is a credit or debit transaction. Populated from the CreditDebit code table.CREDIT_DEBIT_CODECreditDebitSVR_STRING<10>
currencyTypeCodedetails Code value to denote the type of currency.CURRENCY_CODECurrencySVR_STRING<10>
currencyExchangeIDdetailsyesUnique identifier assigned by the system to the foreign exchange rate for a specific currency type for a specific time period.CURRENCY_EXCHANGE_ID SVR_INT64
instrumentGenInddetails Indicator value to denote whether or not a Payment or Liability Instrument is to be generated.CURAM_INDICATOR SVR_BOOLEAN
commentsdetails Free text registered by the UserCOMMENTS SVR_STRING<300>
Foreign Keys (12)
ChildParent
FinancialInstruction.concernRoleIDConcernRole.concernRoleID
FinancialInstruction.currencyExchangeIDCurrencyExchange.currencyExchangeID
AdjustmentInstruction.finInstructionIDFinancialInstruction.finInstructionID
FinancialInstructionStatus.finInstructionIDFinancialInstruction.finInstructionID
InstructionLineItem.finInstructionIDFinancialInstruction.finInstructionID
LiabilityInstruction.finInstructionIDFinancialInstruction.finInstructionID
PaymentInstruction.finInstructionIDFinancialInstruction.finInstructionID
PaymentReceivedInstruction.finInstructionIDFinancialInstruction.finInstructionID
PaymentRegenerationRequest.regenFinInstructIDFinancialInstruction.finInstructionID
ReversalInstruction.finInstructionIDFinancialInstruction.finInstructionID
WMInstanceData.financialInstructionIDFinancialInstruction.finInstructionID
WriteOffInstruction.finInstructionIDFinancialInstruction.finInstructionID
Indices (3)
Index NameAttributes
FIConRoleEffDateconcernRoleID, effectiveDate
FIConRoleIdTypeStaconcernRoleID, typeCode, statusCode
FiancInstrIdxcurrencyExchangeID
Operations (20)
OperationStereotypeOptionsDescriptionSQL
insertinsert Standard Operation 
readread Standard Operation 
modifyStatusnsmodifyOPTIMISTIC_LOCKING: yes
To modify the statusCode by optimistic locking on a Financial Instruction record. 
searchByConcernRoleIDTypeStatusnsreadmulti To get a list of financial instructions of one type with a particular status, for a specified concern role. 
searchByConcernRoleIDDateRangensmulti To get a list of financial instructions for a Concern Role.SQL
modifyStatusAmountEffectDatensmodifyOPTIMISTIC_LOCKING: yes
To update the statusCode, effectiveDate and amount by optimistic locking on a financial instruction record. 
searchByConcernRoleIDStatusDateRangensmulti To get a list of financial instructions for a Concern Role.SQL
searchByEffectiveDateRangereadmultiORDER_BY: effectiveDate
WHERE: financialInstruction.effectiveDate >= :effectiveDateFrom and financialInstruction.effectiveDate <= :effectiveDateTo
To retrieve all records from the FinancialInstruction entity where the effectiveDate is greater than the effectiveDateFrom and less than the effectiveDateTo. 
modifyAmountEffectDatensmodifyOPTIMISTIC_LOCKING: yes
To update the effectiveDate and amount by optimistic locking on a financial instruction record. 
readLatestEffDateByConcernRoleIDns To get the maximum effective Date from the FinancialInstruction entity using concernRoleID.SQL
searchByCreationDateRangereadmultiORDER_BY: postingDate
WHERE: financialInstruction.postingDate >= :creationDateFrom and financialInstruction.postingDate <= :creationDateTo
Searches FinancialInstruction table and returns all records created in the date range supplied 
getLatestEffDateByConcernRoleID  @superseded - replaced by readLatestEffDateByConcernRoleID 
searchAmountByStatusTypeAndCaseIDnsmulti Returns amounts from all Financial Instruction records of specified type that have one of the two statuses required and belong to the specified case.SQL
readFinInstructIDEffDateTypeAmtnsread Returns financial instruction details for case instruction details list. 
readStatusnsread Returns the status code for a financial instruction. 
modifyCurExchgIDEffectiveDatebyKeynsmodify To update the currency exchange id and effective date by optimistic locking on a financial instruction record 
readPaymentDateDetailsByCaseAndInstructionIDns Reads the payment date for a financial instruction. The payment date is the latest due date on the instruction line items for an instruction.SQL
readFinInstructListDetailns Reads the amount, effective date, type code, posting date and status code for a financial instruction.SQL
readPaymentDateDetailsByInstructionIDns Reads the payment date for a financial instruction. The payment date is the latest due date on the instruction line items for an instruction.SQL
readByFinIDStatusCodensread Returns financial instruction details for financial instruction key and status code information. 
Related Pages (170)
BenefitSample_listFinInstruction
Case Financials (BenefitSampleOverpayment_listFinInstruction)
BenefitSampleOverpayment_listFinInstruction1
CAPreviewPanel
CAProductHomeDetails
CREOLECAProductHomeDetails
CREOLEFAProductHomeDetails
Financials (DefaultICEmployer_listFinancial)
Financials (DefaultICInformationProvider_listFinancial)
Financials (DefaultICMember_listFinancial)
Transactions (DefaultICProduct_listTransaction)
Financials (DefaultICProductProvider_listFinancial)
Financials (DefaultICProspectPerson_listFinancial)
Financials (DefaultICRepresentative_listFinancial)
Financials (DefaultICServiceSupplier_listFinancial)
Financials (DefaultICUtility_listFinancial)
Financials (Employer_listFinancial)
Employer_listFinancial1
External Party Financials (ExternalParty_listFinancial)
ExternalParty_listFinancial1
Regenerate Payment (ExternalParty_regeneratePayment)
Adjustment Instruction Details (ExternalParty_viewAdjustmentInstruction)
Financial Line Item Details (ExternalParty_viewLineItem)
Payment Instruction Details (ExternalParty_viewNonClientPaymentInstruction)
Payment Instruction Details (ExternalParty_viewPaymentInstruction)
FAPreviewPanel
FAProductHomeDetails
Approve Payment (Financial_approvePayment)
Canceled Payment Details (Financial_cancelledPaymentInstruction)
Cancel Payment (Financial_cancelPayment)
Cancel Payment (Financial_cancelPayment1)
Cancel Issued Payment (Financial_cancelPaymentInstrument)
Capture Account Adjustment (Financial_captureAccountAdjustment)
Reissue with Applied Deduction (Financial_createAppliedFixedDeductionWizard)
Reverse Instruction (Financial_createInstructionReversal)
Reverse Details (Financial_createLineItemReversal)
Create Manual Payment (Financial_createManualPayment)
Record Manually Issued Payment (Financial_createManualPaymentWizard)
Refund Payment (Financial_createRefund)
Reissue with Un-applied Deduction (Financial_createUnappliedDeductionWizard)
Create Write Off (Financial_createWriteOff)
Create Write Off (Financial_createWriteOff1)
Invalidate Payment (Financial_invalidatePayment)
Financial_liabilitySearch
New Account Adjustment (Financial_newAccountAdjustment)
Financial_paymentReceivedSearch
Receive Payment for an Employer (Financial_recordPaymentReceivedForEmployer)
Receive Payment for a Person (Financial_recordPaymentReceivedForPerson)
Receive Payment Into Suspense Account (Financial_recordPaymentReceivedInSuspense)
Refund Payments (Financial_refundPayments)
Confirm & Reissue (Financial_regenerateAppliedFixedDeduction)
Regenerate Payment For New Nominee: (Financial_regenerateForNewNominee)
Regenerate Payment (Financial_regeneratePayment)
Reissue Payment (Financial_regeneratePayment1)
Reissue Payment Instrument (Financial_regeneratePaymentInstrument)
Reissue with Un-applied Deduction (Financial_regenerateUnappliedDeduction)
Reversed Liability Details (Financial_reversedLiabilityInstruction)
Transfer From Suspense To Client (Financial_suspenseTransferIssuerDetails)
Transfer from Suspense Account to Employer (Financial_suspenseTransferToEmployerDetails)
Transfer from Suspense Account to Person (Financial_suspenseTransferToPersonDetails)
Adjustment Instruction Details (Financial_viewAdjustmentInstruction)
Account Adjustment Details (Financial_viewAdjustmentInstruction1)
Liability Instruction Details (Financial_viewLiabilityInstruction)
Liability Details (Financial_viewLiabilityInstruction1)
Liability Details (Financial_viewLiabilityInstructionDetailsTransaction)
Manual Payment Details (Financial_viewManualPaymentInstruction)
Payment Instruction Details (Financial_viewNonClientPaymentInstruction)
Payment Instruction Details (Financial_viewNonClientPaymentInstruction1)
Payment Details (Financial_viewPaymentInstruction)
Payment Details (Financial_viewPaymentInstruction1)
Payment Instruction Details (Financial_viewPaymentInstructionDetailsTransaction)
Financial_viewPaymentInstructionInline
Payment Details (Financial_viewPaymentInstructionModal)
- (Financial_viewPaymentInstrument)
Payment Instrument Details (Financial_viewPaymentInstrument1)
Payment Received Details (Financial_viewPaymentReceivedInstruction)
Payment Received (Financial_viewPaymentReceivedInstruction1)
Payment Received Details (Financial_viewPaymentReceivedInstructionDetailsTransaction)
Reversal Instruction Details (Financial_viewReversalInstruction)
Reversal Instruction Details (Financial_viewReversalInstructionDetailsTransaction)
Payment Details (Financial_viewUnderpmtPaymentInstruction)
Write Off Instruction Details (Financial_viewWriteOffInstruction)
Write Off (Financial_viewWriteOffInstruction1)
Check Retroactive Medicaid Eligibility (HCRRetroactiveMedicaid_confirmCheckEligibilty)
Case Financials (ICBenefitUnderPayment_listFinInstruction)
ICBenefitUnderPayment_listFinInstruction1
Financials (ICEmployer_listFinancial)
Financials (ICInformationProvider_listFinancial)
Financials (ICMember_listFinancial)
Financials (ICPerson_listFinancial)
Financials (ICProductProvider_listFinancial)
Case Financials (ICProductSample_listFinancial)
Case Financials (ICProductSample_listFinInstruction)
ICProductSample_listFinInstruction1
Financials (ICProspectPerson_listFinancial)
Financials (ICRepresentative_listFinancial)
Financials (ICServiceSupplier_listFinancial)
Case Financials (ICSportingGrantSample_listFinancial)
Case Financials (ICSportingGrantSample_listFinInstruction)
ICSportingGrantSample_listFinInstruction1
Financials (ICUtility_listFinancial)
Financials (InformationProvider_listFinancial)
InformationProvider_listFinancial1
Cancel Sanction (ISP_cancelSanctionEvidence)
Cancel Disregard (ISP_cancelSanctionOverride)
New Pay In Evidence (ISP_createISPPayInProductEvidence_sa)
Assign New Pay In (ISP_createPayInEvidenceFromApplyNewPayInFromSD)
New Sanction (ISP_createSanctionEvidence)
New Disregard (ISP_createSanctionOverride)
Edit Sanction (ISP_modifySanctionEvidence_fromList)
Edit Sanction (ISP_modifySanctionEvidence_fromView)
Edit Disregard (ISP_modifySanctionOverride_fromList)
Modify Sanction Override Details: (ISP_modifySanctionOverride_fromView)
Financials (ISPEmployer_listFinancial)
Financials (ISPMember_listFinancial)
Financials (ISPPerson_listFinancial)
Transactions (ISPProduct_listFinInstruction)
Financials (ISPProductProvider_listFinancial)
Financials (ISPRepresentative_listFinancial)
Financials (ISPServiceSupplier_listFinancial)
Financials (ISPUtility_listFinancial)
Case Financials (LiabilityOverbilling_listFinInstruction)
Case Financials (LiabilitySample_listFinInstruction)
LiabilitySample_listFinInstruction1
Capture Account Adjustment (Participant_captureAccountAdjustment)
Reverse Line Item (Participant_createLineItemReversal)
New Write Off (Participant_createWriteOff)
New Account Adjustment (Participant_newAccountAdjustment)
- (Participant_regeneratePaymentInstrument)
Adjustment Instruction Details (Participant_viewAdjustmentInstruction)
Liability Instruction Details (Participant_viewLiabilityInstruction)
Liability Instruction Details (Participant_viewLiabilityInstructionFromWriteOff)
Payment Instruction Details (Participant_viewNonClientPaymentInstruction)
Payment Details (Participant_viewPaymentInstruction)
- (Participant_viewPaymentInstrument)
Payment Received Details (Participant_viewPaymentReceivedInstruction)
Reversal Instruction Details (Participant_viewReversalInstruction)
Write Off Instruction Details (Participant_viewWriteOffInstruction)
PaymentCorrection_listTransaction
PDBenefitUnderPayment_listFinInstruction
PDServiceDelivery_listTransaction
Financials (Person_listFinancial)
Transactions (Person_listFinancial1)
Financials (Person_listFinancialForDuplicate)
Person_listFinancialForDuplicate1
Third Party Deduction (ProductDelivery_listThirdPartyDeductionHistory)
Payment Details (ProductDelivery_viewDedPaymentInstruction)
View Third Party Deduction (ProductDelivery_viewThirdPartyDeductionDetails1)
Financials (ProductProvider_listFinancial)
ProductProvider_listFinancial1
Liabilities (ProviderManagement_listLiabilitiesForProvider)
Liabilities (ProviderManagement_listLiabilitiesForProviderGroup)
Transactions (ProviderManagement_listProviderGroupPaymentTransactions)
Transactions (ProviderManagement_listProviderPaymentTransactions)
Payment Instruction Details (ProviderManagement_viewBenefitUnderPaymentInstruction)
View Provider Deduction History: (ProviderManagement_viewThirdPartyProviderDeductionHistory)
Financials (Representative_listFinancial)
Representative_listFinancial1
New Disregard (SanctionAssessment_createDisregard_CREOLE)
New Sanction (SanctionAssessment_createSanction_CREOLE)
Edit Sanction (SanctionAssessment_modifySanction)
Edit Recommendation Disregard (SanctionAssessment_modifySanctionOverride)
ServiceDelivery_listTransaction
Financials (ServiceSupplier_listFinancial)
ServiceSupplier_listFinancial1
Liability Instruction Details (SocialEnterpriseFolder_viewFinancialLiabilityInstruction)
Payment Instruction Details: (SocialEnterpriseFolder_viewFinancialPaymentInstruction)
Payment Received Details (SocialEnterpriseFolder_viewFinancialPaymentReceivedInstruction)
Financials (Utility_listFinancial)
Utility_listFinancial1