Table Description
External Payment: A record of a payment made to a citizen that was processed on a Remote System.

Example

The Agency has a legacy system for processing Program A. A payment is issued by this legacy system to the citizen. As part of the payment processing, a web service is invoked that sends information to Citizen Workspace so it can be displayed to the citizen.
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::WorkspaceServices::Entity::ExternalPayment::ExternalPayment
Controlling File: WorkspaceServices\model\Packages\Entity\ExternalPayment\ExternalPayment.efx
Table Options
ALLOW_OPTIMISTIC_LOCKINGno
Attributes (18)
AttributeStereotypeNullableDescriptionDomain DefinitionCodetableDDL Type
externalPaymentIDkeynoUnique reference number of this record.INTERNAL_ID SVR_INT64
cityIndustryTypedetailsyesCode table to denote the type of industry that this message has originitated from.CITY_INDUSTRY_TYPECityIndustrySVR_STRING<10>
citizenWorkspaceAccountIDdetailsnoUnique reference number of the account that this payment relates to.INTERNAL_ID SVR_INT64
effectiveDatedetailsnoEffective date of the payment.CURAM_DATE SVR_DATE
paymentMethoddetailsyesIndicates how this payment was made, for example, cheque.METHOD_OF_DELIVERY_CODEMethodOfDeliverySVR_STRING<10>
statusdetailsnoStatus of this payment, for example, cancelled, expired, processed.PMT_RECONCILIATION_STATUS_CODEPmtReconciliationStatusSVR_STRING<10>
amountdetailsnoThe amount of this payment.CURAM_AMOUNT SVR_MONEY
currencydetailsyesThe currency in which the payment was made.CURRENCY_CODECurrencySVR_STRING<10>
payeeNamedetailsnoThe name of the person in receipt of this payment.CONCERN_ROLE_NAME SVR_STRING<131>
addressdetailsyesThe address that the payment was sent to( in the case of a cheque).ADDRESS_STRING SVR_STRING<131072>
dueDatedetailsnoThe date the payment was due to be paid.CURAM_DATE SVR_DATE
referenceNumberdetailsyesUnique reference number of this payment on the remote system.REFERENCE_NUMBER SVR_STRING<20>
bankSortCodedetailsyesSort code of the back that the payment was made to( if the payment was made into a bank account).BANK_SORT_CODE SVR_STRING<10>
bankAccountNumberdetailsyesThe bank account number that the payment was made into.BANK_ACCOUNT_NUMBER SVR_STRING<16>
remoteSystemIDdetailsnoUnique reference number of the system that this payment came from.INTERNAL_ID SVR_INT64
remoteSystemPaymentIDdetails Unique reference number of this payment on the remote system.REMOTE_ID SVR_STRING<128>
coverPeriodStartDatedetailsnoThe start date of the period that this payment covers.CURAM_DATE SVR_DATE
coverPeriodEndDatedetailsnoThe end date of the period that this payment covers.CURAM_DATE SVR_DATE
Foreign Keys (3)
ChildParent
ExternalPayment.citizenWorkspaceAccountIDIntakeClient.intakeClientID
ExternalPayment.remoteSystemIDRemoteSystem.remoteSystemID
ExternalPaymentBreakdown.externalPaymentIDExternalPayment.externalPaymentID
Indices (3)
Index NameAttributes
IND__2134740204remoteSystemID
IND_1488194920remoteSystemPaymentID
IND__1051097897citizenWorkspaceAccountID
Operations (5)
OperationStereotypeOptionsDescriptionSQL
insertinsertAUTO_ID: externalPaymentID
Standard Operation 
readread Standard Operation 
searchByAccountreadmultiORDER_BY: coverPeriodStartDate
WHERE: ExternalPayment.citizenWorkspaceAccountID = :accountID
Returns a list of payment instruments for a participant. 
removeremove Standard Operation 
readByRemoteSystemRefnsread Reads an External Payment record that has the given Remote System ID and Remote System Payment ID. 
Related Pages (0)