Table Description
Payment Received Instrument: A physical payment received from 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::PaymentReceivedInstrument::PaymentReceivedInstrument
Controlling File: core\model\Packages\Financial Manager Packages\PaymentReceivedInstrument_cat.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGyes
Attributes (14)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
pmtRecInstrumentIDkeynoUnique reference number assigned by the system to a Payment Received Instrument RecordPAYMENT_RECEIVED_INSTRUMENT_ID SVR_INT64
amountdetails A financial amount associated with the Payment Received Instruction, Instrument or a suspense account item.CURAM_AMOUNT SVR_MONEY
receivedDatedetails Date Payment Received was registered as received by the Organization.CURAM_DATE SVR_DATE
creationDatedetails Date Payment Received Instruction was created on the system.CURAM_DATE SVR_DATE
effectiveDatedetails Date Payment Received is valid from.CURAM_DATE SVR_DATE
receiptMethodCodedetails Code value to indicate the type of payment received by the Organization. Populated from MethodOfReceipt code table.METHOD_OF_RECEIPT_CODEMethodOfReceiptSVR_STRING<10>
concernRoleIDdetailsnoConcernRoleID of the Concern in respect of which this PaymentReceivedInstrument was issued.CONCERN_ROLE_ID SVR_INT64
issuerNamedetails The name of the party who issued the Payment Received Instrument.ISSUER_NAME SVR_STRING<131>
addressIDdetailsyesAddressID of the address of the party who issued the Payment Received Instrument.ADDRESS_ID SVR_INT64
currencyTypeCodedetails Code value to denote the type of currency.CURRENCY_CODECurrencySVR_STRING<10>
currencyExchangeIDdetailsyesCurrencyExchangeID of the CurrencyExchange record for this PaymentReceivedInstrument.CURRENCY_EXCHANGE_ID SVR_INT64
depositSlipNumberdetails Identifier of the deposit slip on which the PaymentReceivedInstrument was included.DEPOSIT_SLIP_NUMBER SVR_INT32
receiptNumberdetails Identifier of the receipt slip generated to the Client in respect of this PaymentReceivedInstrument.RECEIPT_NUMBER SVR_INT64
liabilityExternalRefNodetails Reference number which relates to the liabilityInstrument to which this payment received is in respect of.INTERNAL_ID SVR_INT64
Foreign Keys (8)
ChildParent
PaymentReceivedInstrument.addressIDAddress.addressID
PaymentReceivedInstrument.concernRoleIDConcernRole.concernRoleID
PaymentReceivedInstrument.currencyExchangeIDCurrencyExchange.currencyExchangeID
CashReceived.pmtRecInstrumentIDPaymentReceivedInstrument.pmtRecInstrumentID
ChequeReceived.pmtRecInstrumentIDPaymentReceivedInstrument.pmtRecInstrumentID
PaymentReceivedInstruction.pmtRecInstrumentIDPaymentReceivedInstrument.pmtRecInstrumentID
StandingOrder.pmtRecInstrumentIDPaymentReceivedInstrument.pmtRecInstrumentID
SuspenseAccount.pmtRecInstrumentIDPaymentReceivedInstrument.pmtRecInstrumentID
Indices (10)
Index NameAttributes
PRIAmountEffDateamount, effectiveDate
PRIAmtMethodEffamount, receiptMethodCode, effectiveDate
PRIAmtMethodRecvdamount, receiptMethodCode, receivedDate
PRIAmtRecvdDateamount, receivedDate
PRIEffDateMethodeffectiveDate, receiptMethodCode
PRDatesIdxreceivedDate, effectiveDate
PRIRecDateMethodInreceiptMethodCode, receivedDate
PayRecInstrumentIdxaddressID, currencyExchangeID
PRIConcernRoleDateconcernRoleID, receivedDate
PRIConcAmtMethodconcernRoleID, amount, receiptMethodCode
Operations (19)
OperationStereotypeOptionsDescriptionSQL
insertinsertPOST_DATA_ACCESS: yes
PRE_DATA_ACCESS: no
Standard Operation 
readread Standard Operation 
searchByAmountReceiptMethodnsmulti To search the Payment Received Instrument table to retrieve all rows where amount = input amount and the receipt method code = input receipt method codeSQL
searchByReceivedEffectiveDatensmulti To access Payments Received Instruments using effective and received datesSQL
searchByReceivedDateRangeReceiptMethodnsmulti To search the Payment Received Instrument using receipt method code and receivedDate >= receivedDateFrom (input)and receivedDate <= receivedDateTo (input)SQL
searchByReceivedDateRangensmulti To search Payment Received Instrument where the receivedDate >= input receivedDateFrom and receivedDate <= input receivedDateTo.SQL
searchByReceivedDatensmulti To search Payment Received Instrument using a specified receivedDate.SQL
searchByReceiptMethodnsmulti Search of the Payment Received Instrument using a specified receiptMethodCode.SQL
searchByReceivedDateReceiptMethodnsmulti Search of Payment Received Instrument using a specific receivedDate and receiptMethodCode.SQL
searchForPaymentsReceivednsmulti Search of the PaymentReceivedInstrument table based on the concernRoleID and/or a combination of all other input fields.SQL
searchByEffectiveDatensmulti To select from the Payment Received Instrument using effectiveDate.SQL
searchByEffectiveDateReceiptMethodnsmulti To select from the Payment Received Instrument table using effectiveDate and receiptMethodCode.SQL
searchByAmountReceivedDatensmulti To search Payment Received Instrument using amount and receivedDateSQL
searchByAmountReceivedDateRangensmulti To search the Payment Received Instrument using amount and a specified received date range SQL
searchByAmountEffectiveDatensmulti To search Payment Received Instrument using amount and effectiveDateSQL
searchByAmountReceiptMethodEffectiveDatensmulti To search Payment Received Instrument using amount, receiptMethodCode and effectiveDate SQL
searchByAmountReceiptMethodReceivedDatensmulti To search Payment Received Instrument using amount, receiptMethodCode and receivedDate SQL
readAllnkreadmulti Retrieves a list of all payment received instruments. 
searchByAmountReceiptMethodReceivedDateRangensmulti To search Payment Received Instrument using amount, receiptMethodCode and where the receivedDate >= input receivedDateFrom and receivedDate <= input receivedDateTo.SQL
Related Pages (53)
Adjustment Instruction Details (ExternalParty_viewAdjustmentInstruction)
Financial Line Item Details (ExternalParty_viewLineItem)
Payment Instruction Details (ExternalParty_viewNonClientPaymentInstruction)
Payment Instruction Details (ExternalParty_viewPaymentInstruction)
Canceled Payment Details (Financial_cancelledPaymentInstruction)
Reissue with Applied Deduction (Financial_createAppliedFixedDeductionWizard)
Reissue with Un-applied Deduction (Financial_createUnappliedDeductionWizard)
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)
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)
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)
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)
New Pay In Evidence (ISP_createISPPayInProductEvidence_sa)
Assign New Pay In (ISP_createPayInEvidenceFromApplyNewPayInFromSD)
Adjustment Instruction Details (Participant_viewAdjustmentInstruction)
Liability Instruction Details (Participant_viewLiabilityInstruction)
Liability Instruction Details (Participant_viewLiabilityInstructionFromWriteOff)
Payment Instruction Details (Participant_viewNonClientPaymentInstruction)
Payment Details (Participant_viewPaymentInstruction)
Payment Received Details (Participant_viewPaymentReceivedInstruction)
Reversal Instruction Details (Participant_viewReversalInstruction)
Write Off Instruction Details (Participant_viewWriteOffInstruction)
Payment Details (ProductDelivery_viewDedPaymentInstruction)
Payment Instruction Details (ProviderManagement_viewBenefitUnderPaymentInstruction)
Liability Instruction Details (SocialEnterpriseFolder_viewFinancialLiabilityInstruction)
Payment Instruction Details: (SocialEnterpriseFolder_viewFinancialPaymentInstruction)
Payment Received Details (SocialEnterpriseFolder_viewFinancialPaymentReceivedInstruction)