Table Description
Payment Instrument: A physical payment generated from a payment instruction.

Example

A check.
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::PaymentInstrument::PaymentInstrument
Controlling File: core\model\Packages\Financial Manager Packages\PaymentInstrument_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (19)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
pmtInstrumentIDkeynoUnique reference number assigned by the system to a Payment Instrument RecordPAYMENT_INSTRUMENT_ID SVR_INT64
amountdetails A financial amount associated with the Payment Instrument.CURAM_AMOUNT SVR_MONEY
effectiveDatedetails Date Payment Instrument is valid for payment to the NomineeCURAM_DATE SVR_DATE
creationDatedetails Date Payment Instrument was created on the system.CURAM_DATE SVR_DATE
deliveryMethodTypedetails Code to denote the type of Method of Delivery for a Case which has a Financial output.METHOD_OF_DELIVERY_CODEMethodOfDeliverySVR_STRING<10>
reconcilStatusCodedetails Code value to denote the reconciliation status of the Payment Instrument. Populated from the PaymentReconciliationStatus code tablePMT_RECONCILIATION_STATUS_CODEPmtReconciliationStatusSVR_STRING<10>
concernRoleIDdetailsnoConcernRoleID of the ConcernRole in respect of which this PaymentInstrument was generatedCONCERN_ROLE_ID SVR_INT64
concernRoleNamedetails The governing First Name and Surname or label utilized by the Concern Role in their interaction with the Organization in that role type. Denormalized from the ConcernRole table.CONCERN_ROLE_NAME SVR_STRING<131>
caseNomineeIDdetailsyesCaseNomineeID of the Case Nominee for this PaymentInstrument.CASE_NOMINEE_ID SVR_INT64
nomineeNamedetails The governing First Name and Surname or label utilized by the Nominee who is the Financial Agent for the Case. Denormalized from Nominee.NOMINEE_NAME SVR_STRING<131>
nomineeAlternateIDdetails Reference number that may be used as an alternate identification which may have been assigned to the Nominee by an external organization. Denormalized from Nominee.NOMINEE_ALTERNATE_ID SVR_STRING<18>
addressIDdetailsnoAddressID of the address to which this PaymentInstrument will be generatedADDRESS_ID SVR_INT64
currencyTypeCodedetails Code value to denote the type of currency.CURRENCY_CODECurrencySVR_STRING<10>
currencyExchangeIDdetailsyesCurrencyExchangeID of the CurrencyExchange for this PaymentInstrument.CURRENCY_EXCHANGE_ID SVR_INT64
bankAccountIDdetailsyesBankAccountID of the Bank Account to which an Electronic Fund Transfer(E.F.T) Payment has been issuedBANK_ACCOUNT_ID SVR_INT64
referenceNumberdetails ReferenceNumber is the ChequeNumber or LedgerNumber or VoucherNumber of the PaymentInstrument being generatedREFERENCE_NUMBER SVR_STRING<20>
referenceTextdetails ReferenceText contains the name of the Organization to which the BankAccountID refers.REFERENCE_TEXT SVR_STRING<40>
pslipInstructionIDdetailsyespslipInstructionID being added to Payment Instrument after been removed from the Payment Instruction.PAYSLIP_INSTRUCTION_ID SVR_INT64
invalidatedInddetails  CURAM_INDICATOR SVR_BOOLEAN
Foreign Keys (8)
ChildParent
PaymentInstrument.addressIDAddress.addressID
PaymentInstrument.bankAccountIDBankAccount.bankAccountID
PaymentInstrument.concernRoleIDConcernRole.concernRoleID
PaymentInstrument.currencyExchangeIDCurrencyExchange.currencyExchangeID
PaymentInstrument.pslipInstructionIDPayslipInstruction.pslipInstructionID
PaymentCancellationRequest.pmtInstrumentIDPaymentInstrument.pmtInstrumentID
PaymentInstruction.pmtInstrumentIDPaymentInstrument.pmtInstrumentID
PmtInstrumentReconciliation.pmtInstrumentIDPaymentInstrument.pmtInstrumentID
Indices (7)
Index NameAttributes
PIAmtMethodDateamount, deliveryMethodType, effectiveDate
PIAmtEffDateamount, effectiveDate
PIEffDateeffectiveDate
PIStatusMethodEffDreconcilStatusCode, deliveryMethodType, effectiveDate
PayInstrIdxconcernRoleID, bankAccountID, currencyExchangeID, addressID
PIPslipInstructionIdxpslipInstructionID
IND_1375166626referenceNumber
Operations (40)
OperationStereotypeOptionsDescriptionSQL
insertinsertPOST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
Standard Operation 
readread Standard Operation 
searchByAmountDeliveryMethodnsmulti Search of the Payment Instrument by amount, deliveryMethodType and statusCode SQL
searchByDeliveryMethodStatusEffectiveDatensmulti To search the PaymentInstrument using the delivery method code, the status code and the effective date < the input effective dateSQL
modifyReconcilStatusCodensmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
to modify the reconcilStatusCode of the PaymentInstrument to show that this payment instrument has expired 
searchByEffectiveDatensmulti Search of the Payment Instrument by effectiveDateSQL
searchByEffectiveDateAmountnsmulti Search of the Payment Instrument by effectiveDate and amount SQL
searchByEffectiveDateAmountDeliveryMethodnsmulti Search of the Payment Instrument by effectiveDate, amount and deliveryMethodType SQL
searchByEffectiveDateDeliveryMethodnsmulti Search of the Payment Instrument by effectiveDate, deliveryMethodType and statusCode SQL
searchByEffectiveDateRangensmulti Search of the Payment Instrument by effectiveDateFrom, effectiveDateTo and statusCode SQL
searchByEffectiveDateRangeAmountnsmulti Search of the Payment Instrument by effectiveDateFrom, effectiveDateTo, amount and statusCode SQL
searchByEffectiveDateRangeAmtDeliveryMethodnsmulti Search of Payment Instrument by effectiveDateFrom, effectiveDateTo, amount, deliveryMethodType and statusCode SQL
searchByEffectiveDateRangeDeliveryMethodnsmulti Search of the Payment Instrument by effectiveDateFrom, effectiveDateTo, deliveryMethodType and statusCode SQL
searchByStatusCodeDeliveryMethodnsreadmulti Operation to read the Payment Instrument table to retrieve all "Un-issued" payment instruments by delivery method code  
searchForDeliveryMethodnsmulti Searches for the distinct delivery methods of the Payment Instrument.SQL
searchByStatusCodensreadmulti To retrieve all records from the Payment Instrument table based on status code 
modifyAmountEffectDatensmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
To update the amount and effectiveDate by optimistic locking on a specified paymentInstrument record. 
searchForPmtIssuedByConcRoleNameDatansmulti Search of Payment Instrument by exact match concernRoleName and/or a combination of all other input fields SQL
searchForPmtsIssuedByConcRoleIDDatansmulti Search of Payment Instrument by concernRoleID and/or a combination of all other input fields SQL
countActiveBankAccountsnsPRE_DATA_ACCESS: yes
 		Operation to count the number of occurrences of the specified (active) Bank Account.SQL
readByDeliveryMethodRefNonsread To read the payment instrument entity based on DeliveryMethod and RreferenceNumber. 
modifyStatusAmountEffectDatensmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
To update the Status, amount and effectiveDate by optimistic locking on a specified paymentInstrument record. 
readReconcilStatusByPslipInstructionIDnsread Reads the reconcilStatusCode by payslipInstructionID. 
searchByStatusEffectiveDatensmulti To search the PaymentInstrument using the status code and the effective date < the input effective dateSQL
readActiveBankAccounts  @superseded - replaced by countActiveBankAccounts 
searchConcernRolePaymentByConcernRoleIDnsmulti Returns a list of payment instrument details for a participant.SQL
searchCaseNomineePaymentByConcernRoleIDStatusnsmulti Returns payment instruments for a nominee using the concern role id of the nominee.SQL
modifyReconcilStatusCodeInvalidatedIndnsmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
Marks a payment as canceled and invalidated. 
modifyInvalidatedIndnsmodifyOPTIMISTIC_LOCKING: yes
POST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
Marks a payment as invalidated. 
readInvalidatedIndnsread   
modifyEffectiveDateReconcilStatusnsmodifyPOST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
This method updates the effective date and the reconcile status of the specified payment instrument. 
readCreationDateEffectiveDatensread This method returns the creation date and effective date of the specified payment instrument. 
readAllnkreadmulti   
searchByEffectiveDateAmountDeliveryMethodStatusCodensmulti Search of the Payment Instrument by effectiveDate, amount, deliveryMethodType and statusCode SQL
searchByEffectiveDateAmountStatusCodensmulti Search of the Payment Instrument by effectiveDate, amount and statusCode SQL
searchByEffectiveDateStatusCodensmulti Search of the Payment Instrument by effectiveDate and statusCodeSQL
searchByConcernRolereadmultiWHERE: PaymentInstrument.concernRoleID = :concernRoleID
Returns a list of payment instruments for a participant. 
searchForPmtIssuedByPartialMatchConcRoleNameDatansmulti Search of Payment Instrument by partial match concernRoleName and/or a combination of all other input fields SQL
searchByStatusDeliveryMethodnsmulti Reads the payment issued record based on the status code and the delivery method.SQL
searchByAmountStatusCodensmulti Reads the payment received record based on the amount and status code.SQL
Related Pages (139)
BenefitSample_listFinInstruction
Case Financials (BenefitSampleOverpayment_listFinInstruction)
BenefitSampleOverpayment_listFinInstruction1
Transactions (DefaultICProduct_listTransaction)
Payments Issued (EducationalInstitute_listFinancialInstrument)
Financials (Employer_listFinancial)
Employer_listFinancial1
Payments Issued (Employer_listFinancialInstrument)
Payments Issued (Employer_listFinancialInstrument1)
ExternalParty_listFinancial1
External Party Payments Issued (ExternalParty_listFinancialInstrument)
Payments Issued (ExternalParty_listFinancialInstrument1)
Edit Bank Account (ExternalParty_modifyBankAccountFromList)
Edit Bank Account (ExternalParty_modifyBankAccountFromView)
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
ICProductSample_listFinInstruction1
Case Financials (ICSportingGrantSample_listFinancial)
ICSportingGrantSample_listFinInstruction1
Financials (InformationProvider_listFinancial)
InformationProvider_listFinancial1
Payments Issued (InformationProvider_listFinancialInstrument)
Payments Issued (InformationProvider_listFinancialInstrument1)
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)
Transactions (ISPProduct_listFinInstruction)
Case Financials (LiabilityOverbilling_listFinInstruction)
Case Financials (LiabilitySample_listFinInstruction)
LiabilitySample_listFinInstruction1
Edit Bank Branch (Organization_modifyBankBranchFromList)
Edit Bank Branch (Organization_modifyBankBranchFromView)
Reverse Line Item (Participant_createLineItemReversal)
Edit Bank Account (Participant_modifyBankAccount)
Edit Bank Account (Participant_modifyBankAccountFromList)
Edit Bank Account (Participant_modifyBankAccountFromView)
- (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)
Person_listFinancialForDuplicate1
Payments Issued (Person_listFinancialInstrument)
Payments Issued (Person_listFinancialInstrument1)
Payments Issued (Person_listFinancialInstrumentForDuplicate)
Change Nominee Bank Account (ProductDelivery_modifyNomineeBankAccount1)
Payment Details (ProductDelivery_viewDedPaymentInstruction)
Financials (ProductProvider_listFinancial)
ProductProvider_listFinancial1
Payments Issued (ProductProvider_listFinancialInstrument)
Payments Issued (ProductProvider_listFinancialInstrument1)
Liabilities (ProviderManagement_listLiabilitiesForProvider)
Liabilities (ProviderManagement_listLiabilitiesForProviderGroup)
Transactions (ProviderManagement_listProviderGroupPaymentTransactions)
Transactions (ProviderManagement_listProviderPaymentTransactions)
Payment Instruction Details (ProviderManagement_viewBenefitUnderPaymentInstruction)
Financials (Representative_listFinancial)
Representative_listFinancial1
Payments Issued (Representative_listFinancialInstrument)
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
Payments Issued (ServiceSupplier_listFinancialInstrument)
Payments Issued (ServiceSupplier_listFinancialInstrument1)
Liability Instruction Details (SocialEnterpriseFolder_viewFinancialLiabilityInstruction)
Payment Instruction Details: (SocialEnterpriseFolder_viewFinancialPaymentInstruction)
Payment Received Details (SocialEnterpriseFolder_viewFinancialPaymentReceivedInstruction)
Financials (Utility_listFinancial)
Utility_listFinancial1
Payments Issued (Utility_listFinancialInstrument)
Payments Issued (Utility_listFinancialInstrument1)