Table Description
Payment Instruction: A financial instruction of type 'debit' that will generate a payment instrument to send to a participant.
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::PaymentInstruction::PaymentInstruction
Controlling File: core\model\Packages\Financial Manager Packages\PaymentInstruction_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (8)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
pmtInstructionIDkeynoUnique reference number assigned by the system to a Payment Instruction recordPAYMENT_INSTRUCTION_ID SVR_INT64
finInstructionIDdetailsnoFinancialInstructionID of the FinancialInstruction in respect of which this PaymentInstruction was generatedFINANCIAL_INSTRUCTION_ID SVR_INT64
concernRoleIDdetailsnoConcernRoleID of the ConcernRole in respect of which this PaymentInstruction was generatedCONCERN_ROLE_ID SVR_INT64
caseNomineeIDdetailsyesCaseNomineeID of the Case Nominee in respect of whom this paymentInstruction was generated. Optional foreign key linking to CASENOMINEE. A paymentInstruction may exist without Nominee details associated, e.g. payment to a Utility or Tax Authority.CASE_NOMINEE_ID SVR_INT64
pmtInstrumentIDdetailsyesPaymentInstrumentID of the PaymentInstrument generated from this PaymentInstruction, if any.PAYMENT_INSTRUMENT_ID SVR_INT64
amountdetails A financial amount associated with the Payment Instruction.CURAM_AMOUNT SVR_MONEY
deliveryMethodTypedetails Code to denote the type of Method of Delivery for a Case which has a Financial output. Populated from the MethodOfDelivery code table.METHOD_OF_DELIVERY_CODEMethodOfDeliverySVR_STRING<10>
creationDatedetails Date Payment Instruction was created on the system.CURAM_DATE SVR_DATE
Foreign Keys (4)
ChildParent
PaymentInstruction.concernRoleIDConcernRole.concernRoleID
PaymentInstruction.finInstructionIDFinancialInstruction.finInstructionID
PaymentInstruction.pmtInstrumentIDPaymentInstrument.pmtInstrumentID
PaymentRegenerationRequest.pmtInstructionIDPaymentInstruction.pmtInstructionID
Indices (2)
Index NameAttributes
finInstructIdxfinInstructionID
PayInstructionIdxpmtInstrumentID, concernRoleID
Operations (9)
OperationStereotypeOptionsDescriptionSQL
insertinsertPOST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
Standard Operation 
readread Standard Operation 
modifyPmtInstrumentIDnsmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
To update the payment instrument ID by optimistic locking on a payment instruction record. 
modifyPmtInstrumentIDByFinInstructionIDnsmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
To update the payment instrument id on a payment instruction record using the financial instruction id. 
readByFinInstructionIDnsreadPRE_DATA_ACCESS: no
To read a payment instruction record by the financial instruction id. 
readByPmtInstrumentIDnsreadPRE_DATA_ACCESS: no
Operation to read the PaymentInstruction table using the PmtInstrumentID and returning FinInstructionID 
modifyAmountnsmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
To update the amount by optimistic locking on a specified paymentInstruction record. 
searchByPmtInstrumentIDnsreadmulti   
searchByPaymentInstrumentreadmultiWHERE: PaymentInstruction.pmtInstrumentID = :pmtInstrumentID
Retrieves a list of {@link PaymentInstruction} for payment instrument. 
Related Pages (151)
BenefitSample_listFinInstruction
Case Financials (BenefitSampleOverpayment_listFinInstruction)
BenefitSampleOverpayment_listFinInstruction1
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)
Approve Payment (Financial_approvePayment)
Canceled Payment Details (Financial_cancelledPaymentInstruction)
Cancel Payment (Financial_cancelPayment)
Cancel Payment (Financial_cancelPayment1)
Cancel Issued Payment (Financial_cancelPaymentInstrument)
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)
Invalidate Payment (Financial_invalidatePayment)
Financial_paymentSearch
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)
Adjustment Instruction Details (Financial_viewAdjustmentInstruction)
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)
ICBenefitUnderPayment_listFinInstruction1
Financials (ICEmployer_listFinancial)
Financials (ICInformationProvider_listFinancial)
Financials (ICMember_listFinancial)
Financials (ICPerson_listFinancial)
Financials (ICProductProvider_listFinancial)
ICProductSample_listFinInstruction1
Financials (ICProspectPerson_listFinancial)
Financials (ICRepresentative_listFinancial)
Financials (ICServiceSupplier_listFinancial)
Case Financials (ICSportingGrantSample_listFinancial)
ICSportingGrantSample_listFinInstruction1
Financials (ICUtility_listFinancial)
Financials (InformationProvider_listFinancial)
InformationProvider_listFinancial1
Cancel Sanction (ISP_cancelSanctionEvidence)
Cancel Disregard (ISP_cancelSanctionOverride)
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
Reverse Line Item (Participant_createLineItemReversal)
- (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
Payment Details (ProductDelivery_viewDedPaymentInstruction)
Financials (ProductProvider_listFinancial)
ProductProvider_listFinancial1
Payment Details: (ProviderManagement_listAttendancePaymentForProvider)
Payment Details: (ProviderManagement_listFRCPaymentForProvider)
Payment Details: (ProviderManagement_listFRCPaymentForProviderGroup)
Payment Details: (ProviderManagement_listILIDetailsForProvider)
Payment Details: (ProviderManagement_listILIDetailsForProviderGroup)
Liabilities (ProviderManagement_listLiabilitiesForProvider)
Liabilities (ProviderManagement_listLiabilitiesForProviderGroup)
Payments (ProviderManagement_listPaymentsForProvider)
Payments (ProviderManagement_listPaymentsForProviderGroup)
Payment Details: (ProviderManagement_listPlacementPaymentForProvider)
Payment Details: (ProviderManagement_listPlacementPaymentForProviderGroup)
Transactions (ProviderManagement_listProviderGroupPaymentTransactions)
Transactions (ProviderManagement_listProviderPaymentTransactions)
Payment Details: (ProviderManagement_listSIPaymentForProvider)
Payment Details: (ProviderManagement_listSIPaymentForProviderGroup)
Payment Instruction Details (ProviderManagement_viewBenefitUnderPaymentInstruction)
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