Financial Transaction Process Data Integration Point

The purpose of the integration point for financial transaction process data is to allow external components to update information on financial transaction process data and related financial transaction detail process data to OHI Claims Adjudication and Pricing.

Request

This request enables external systems to update financial transaction process data and financial transaction detail process data data. The unique identification consists of the combination of

Claim code (required)
Claim version (required)
Claim Line Code (required for updating financial transaction detail process data related to a claim line transaction) *Component Code (required)
Product Code

The writeFinancialTransactionProcessDataRequest has the following structure: (please refer for the general concepts to the Integration Guide)

<financialTransaction
    claimCode=""
    claimVersion="">
    <financialTransactionProcessData
        indFinancialMessageMand=""
        dueDate=""
        penaltyDate=""
        finMessageBulkingGroup=""
        finTransactionSetGrouping=""
        internalRemarks="">
    </financialTransactionProcessData>
    <financialTransactionDetailList/>
</financialTransaction>

The following snippet contains the financial transaction detail (<financialTransactionDetails/>) structure:

<financialTransactionDetail
    claimLineCode=""
    componentCode=""
    productCode="">
    <financialTransactionDetailProcessData
        payFromBankAccount=""
        invoiceBulkingGroup=""
        invoiceLineBulkingGroup=""
        accountingBulkingGroup=""
        generalLedgerAccount=""
        paymentRecFlexCodeDefCode=""
        counterpartyCode=""
        counterpartyQualifier=""
        paymentBeneficiaryCode=""
        internalRemarks=""
        indInvoice=""
        invoiceDestination=""
        indInvoiceLineGrouping=""
        indAccDetailGrouping="">
    </financialTransactionDetailProcessData>
</financialTransactionDetail>

Financial transaction process data and financial transaction detail process data can only be updated if the corresponding financial transaction has not yet been handled by the generate financial message activity. This is enforced by a business rule.

If at least one of the financial transaction details of a financial transaction cannot be updated, none of the financial transaction details for that financial transaction are updated.

The following checks are performed by the integration point:

Whether the combination of claimCode and claimVersion refers to an existing financial transaction
Whether the combination of claimCode, claimVersion, claimLineCode, componentCode (and optionally productCode) refers to an existing financial transaction detail

Note that updates are for non-reversal financial transactions only; the corresponding reversal record should be updated implicitly in exactly the same way as when creating the reversal record(s).

Response

Response messages are created by the OHI application in response to request messages received from external interfaces. Please refer to the 'Response Messages' section in the HTTP API Integration Points part of the Integration Guide.

The following messages can be returned to clarify why an update request failed to execute.

Code	Severity	Message
FIN-IP-FTPD-001	Fatal	Financial transaction with code {claim transaction code} and version {claim transaction version} could not be found.
FIN-IP-FTPD-002	Fatal	Financial transaction detail with code {claim transaction code}, version {claim transaction version}, claim line code {claim line code}, component code {component code} and product code {product code} could not be found.

Code

Severity

Message

FIN-IP-FTPD-001

Fatal

Financial transaction with code {claim transaction code} and version {claim transaction version} could not be found.

FIN-IP-FTPD-002

Fatal

Financial transaction detail with code {claim transaction code}, version {claim transaction version}, claim line code {claim line code}, component code {component code} and product code {product code} could not be found.