Generate Financial Message
Generate Financial Message activities create financial messages in either XML or Flat File format and record financial processing results for this activity to the financial transaction process data.
Financial transactions are grouped into financial messages and their transaction details are grouped into invoices, invoice lines (if indicator invoice line grouping is set) and accounting details (if indicator accounting detail grouping is set) within the financial messages.
The create financial message process only includes financial transactions of base financial objects for which the Supersede Transactions activity has been done and that had no changes since then.
Within the context of a Financial Message:
-
an invoice is created for each 'invoice grouping' of invoiced transaction details (this occurs within the scope of the financial message’s transactions)
-
if indicator invoice line grouping is set, an invoice line is created for each 'invoice line grouping' of invoiced transaction details (this occurs within the scope of each invoice' s transaction details)
-
if indicator accounting detail grouping is set, an invoice accounting detail is created for each 'accounting detail grouping' of invoiced transaction details (this occurs within the scope of each invoice' s transaction details)
-
a non-invoice accounting detail is created for each 'accounting detail grouping' of non-invoiced transaction details (this occurs within the scope of each financial message’s transaction details)
The Generate Financial Message (XML/Flat File) activity is always done in the context of a financial transaction set; however, financial transactions that have not completed general processing (the general financial processing complete datetime on the base financial object has no value) are excluded.
Although the user execution level of these activities is a financial transaction set, the commit level is the financial message. The financial message creation process step is always executed (and saved) together with the stamping of financial processing results for the financial transactions handled by it. If one of the two process steps cannot be executed successfully, the other process step is rolled back. This does not block the creation of other financial messages that are generated in the context of the financial transaction set.
If a specific financial message cannot be created, message FIN-VL-CRFM-002 is logged for the financial transaction set level activity. The message holds the Financial Message Bulking Group as an identifier for reference.
Generate Financial Message - XML
The parameters for the activity are as follows:
-
Cut-Off Date
Only financial transactions for which general financial processing has been completed, i.e. the general financial processing completed datetime on the base financial object is before the cut-off date and time will be picked up by the Generate Financial Message activity.
-
Cut-Off Time
The cut-off time is always combined with the cut-off date. Cut-off time must be entered in HHMM format.
-
Create Invoice Dynamic Logic Function.
This dynamic logic function must be of signature Create Invoice XML. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Create Invoice Line Dynamic Logic Function
This dynamic logic function must be of signature Create Invoice Line XML. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Create Accounting Detail Dynamic Logic Function
This dynamic logic function must be of signature Create Accounting Detail XML. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Max Total Invoice Amount and Max Total Invoice Amount Curr
The maximum total invoice amount can be used to prevent the total of all invoice amounts for the set from exceeding the value specified. If a currency is specified as well, then that currency is used; if not then the default currency is used; already handled transactions in the set also count towards the maximum.
Financial transaction field 'total amount' is used as input for this calculation. Because financial transaction details cannot span more than one currency, the total amount field and the total amount currency field will always be present. All total amounts in the currency of Max Total Invoice Amount Curr are added until the Max Total Invoice Amount is exceeded. If the sum of the selected financial transactions for the same base financial object is negative it is not included in this count.
-
Include Unfinalized
Evaluates to false if the financial transaction (and thus the base financial object) references a claim that is currently unfinalized. This way sending out a claim that is currently unfinalized can be prevented.
-
Automatic Remove
If set to 'Y' or left unspecified, all financial transactions that are part of the financial transaction set and are not handled by the generate financial message activity (typically financial transactions that are on hold) are removed from the set and the set is closed. * Financial Message Delivery Option
This parameter specifies the available options that OHI Claims supports to deliver the generated financial message(s) to an external system. 1) Message Based: Financial messages can be sent out individually to a pre-configured endpoint as they are generated. 2) File Based: Financial messages are written to a data file and the data file can be made available for download.
Generate Financial Message - Flat File
The parameters for the activity are as follows:
-
Cut-Off Date
Only financial transactions for which general financial processing has been completed, i.e. the general financial processing completed datetime on the base financial object is before the cut-off date and time will be picked up by the Generate Financial Message activity.
-
Cut-Off Time
The cut-off time is always combined with the cut-off date. Cut-off time must be entered in HHMM format.
-
Create Invoice Dynamic Logic Function
This dynamic logic function must be of signature Create Invoice Flat File. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Create Invoice Line Dynamic Logic Function
This dynamic logic function must be of signature Create Invoice Line Flat File. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Create Accounting Detail Dynamic Logic Function
This dynamic logic function must be of signature Create Accounting Detail Flat File. If it is of another signature, error message FIN-VL-CRFM-004 is attached to the activity.
-
Max Total Invoice Amount and Max Total Invoice Amount Curr
The maximum total invoice amount can be used to prevent the total of the invoice amounts from exceeding the value specified. If a currency is specified as well, then that currency is used; if not then the default currency is used.
Financial transaction field 'total amount' is used as input for this calculation. Because financial transaction details cannot span more than one currency, the total amount field and the total amount currency field will always be present. All total amounts in the currency of Max Total Invoice Amount Curr are added until the Max Total Invoice Amount is exceeded. If the sum of the selected financial transactions for the same base financial object is negative it is not included in this count.
-
Include Unfinalized
Evaluates to false if the financial transaction (and thus the base financial object) references a claim that is currently unfinalized. This way sending out a claim that is currently unfinalized can be prevented.
Processing
In most cases, a financial transaction set holds too many financial transactions to be practically included in a single financial message. It is desirable to limit the size of financial messages to avoid very large 'units of work'. Financial transactions and transaction details are grouped at different levels to support flexibility with a variety of financial systems and configurations.
These activities select all financial transactions (including reversal transactions) that are:
-
included in the financial transaction set
-
not handled by the Generate Financial Message activity before
-
not superseded
-
not on hold
A base financial object is on hold whenever there is an active financial hold recorded on one or more of the following:
-
The claim
-
The servicing provider as recorded as the counterparty (payment receiver) and/or the payment beneficiary on one of the financial transaction detail process data
-
The product defined on one of the financial transaction details
-
An active hold is a financial hold that is not released and has an expiration date that is in the future or not specified.
The selected financial transactions are then evaluated further:
-
Financial transactions are grouped per base financial object.
Essentially this will guarantee, that when more than one unprocessed financial transaction exists within the same base financial object and more than one needs to paid, they will not be split up; this can only occur when the message mandatory indicator is set.
-
If Max Total Invoice Amount is specified:
-
Base financial objects in a different currency from Max Total Invoice Amount Curr (or, if left unspecified the default currency) do not need sorting and will be paid out .
-
The base financial objects in the same currency as Max Total Invoice Amount Curr (or, if left unspecified the default currency) are first sorted on ascending payment due date. When more than one financial transaction needs to be paid out and different payment due dates are set, the earliest one is chosen.
-
Within the same payment due date, the base financial objects are subsequently sorted on descending total invoice amount.
-
When adding a base financial object to the stack, it is checked if the total invoice amount for that base financial object would cause the running total to exceed the Max Total Invoice Amount parameter (so amounts with invoice indicator unchecked do not count)
-
If so, then the base financial object is not included in the financial message to be generated and the generator continues with the next base financial object. The next base financial object could have a smaller amount that does fit within the Max Total Invoice Amount and will then be included.
-
This implies that base financial objects with only zero amount transactions are always processed (even if the max has been reached).
-
Each excluded base financial object generates message FIN-FL-CRFM-001
-
-
-
If Max Total Invoice Amount is not specified, no sorting is needed and everything will be paid out.
Grouping of Financial Transactions into Financial Messages
The following attributes are used to group financial transactions into financial messages:
-
Financial Message Bulking Group
The Financial Message Bulking Group is an attribute on the Financial Transaction Process Data.
One financial message is created for each value. All financial transaction details of a financial transaction that is included in a financial message are included in that same financial message. i.e., if the financial message bulking group is populated with the claim code, a separate financial message is created for each claim.
Grouping of Invoiced Financial Transaction Details into Invoices
First all financial transactions with message mandatory indicator set to Y are propagated into separate invoices. After that invoice grouping is applied for which the following attributes are used to group into invoices:
-
Counterparty Code and Counterparty Qualifier ( Payment Receiver Code & Payment Receiver Flex Code Def Code)
-
Invoice Destination
-
Pay From Bank Account
-
Invoice Bulking Group
-
Amount Curr
The first three attributes are available on the financial transaction details process data, the last one on the financial transaction detail.
For each group an invoice context (XML context for the XML activity type or object context for flat file activity type) is created by the system.The invoice amount in the context is the sum of all the invoiced financial transaction details selected for the invoice. A unique OHI Invoice Line Id is generated for each invoice. This Id is included in the context and is also used for stamping on the financial transaction detail process data.
The structure of the XML context is the same as that of the invoice element in the XML message and is described in the section Financial Message Structure - XML. The invoice object context is described in the section Financial Message Structure - Flat File
The appropriate context based on the activity type is passed on to the Create Invoice dynamic logic routine (see Dynamic Logic Functions) for the generation of the invoice(s).
Grouping of Invoiced Financial Transaction Details into Invoice Lines
This step creates one or more invoice lines. If the invoice line grouping indicator on the financial transaction detail process data is set to No an invoice line is created for every financial transaction detail. If the invoice line grouping indicator on the financial transaction detail process data is set to Yes multiple financial transaction details of each invoice can be grouped into a single invoice line; if several details have an unspecified invoice line bulking group, they will also be bulked into one invoice line.
If they are to be grouped into lines, the following attributes are used:
-
Invoice Line Bulking Group (from Financial Transaction Detail Process Data)
-
Reversal Indicator (from Financial Transaction)
For each group (unique combination of criteria) or each financial transaction detail (if grouping is not being done), an invoice line context (XML context for the XML activity type or object context for flat file activity type) is created by the system.The invoice line amount in the context is the sum of all the invoiced financial transaction details selected for the invoice line. A unique OHI Invoice Line Id is generated for each invoice line. This Id is included in the context and is also used for stamping on the financial transaction detail process data.
The structure of the XML context is the same as that of the invoice line element in the XML message and is described in the section Financial Message Structure - XML. The invoice line object context is described in the section Financial Message Structure - Flat File
The appropriate context based on the activity type is passed to the Create Invoice Line dynamic logic routine for the generation of the invoice line(s).
Grouping of Invoiced Financial Transaction Details into Accounting Details
This step of the process creates one or more accounting details for the selected financial transaction details that have that have the indicator invoice set to Yes. If the accounting detail grouping indicator on the financial transaction detail process data is set to No one accounting detail is created for each financial transaction detail. If the accounting detail grouping indicator on the financial transaction detail process data is set to Yes multiple financial transaction details included in the same invoice can be grouped into a single accounting detail; if several details have an unspecified accounting detail bulking group, they will also be bulked into one accounting detail.
If financial transaction details are to be grouped into accounting details and no configurable accounting grouping criteria are defined, the following fixed criteria are used for grouping:
-
General Ledger Account (from Financial Transaction Detail Process Data)
-
Accounting Bulking Group (from Financial Transaction Detail Process Data)
-
Reversal Indicator (from Financial Transaction)
For each group, an accounting detail line context (XML context for the XML activity type or object context for flat file activity type) is created by the system.. A unique OHI Invoice Line Id is generated for each accounting detail line. This Id is included in the context and is also used for stamping on the financial transaction detail process data.
The structure of the XML context is the same as that of the accounting detail line element in the XML message and is described in the section Financial Message Structure - XML. The accounting detail line object context is described in the section Financial Message Structure - Flat File
Appropriate context based on the activity type is passed to the Create Accounting Detail dynamic logic routine for the generation of the accounting detail line(s).
Grouping of Non-invoiced Financial Transaction Details into Accounting Details
This step of the process creates accounting details for the selected Financial Transaction Details that have the indicator invoice set to No. If the accounting detail grouping indicator on the financial transaction detail process data is set to No one accounting detail is created for each financial transaction detail. If the accounting detail grouping indicator on the financial transaction detail process data is set to Yes multiple financial transaction details can be grouped into a single accounting detail.
For each group, an accounting detail line context (XML context for the XML activity type or object context for flat file activity type) is created. Appropriate context based on the activity type is passed to the Create Accounting Detail dynamic logic routine Dynamic Logic Functions for the generation of the accounting detail line(s).
Stamping of Results
The result of the invoice and financial message creation is recorded on the Financial Transaction Process Data and the Financial Transaction Detail Process Data. The base financial object status is updated to indicate that the financial transactions for the base financial object are processed by the financial message creation.
The following attributes are set:
Financial Transaction Process Data
-
Financial Message Id
The identification of the financial message in which the financial transaction is included is stored on financial transaction process data level.
-
Financial Message Result
Financial Message Result is an indicator on financial transaction process data level that shows that a financial transaction is handled by the generate financial message activity.
The following values can be set:
-
M (Message Created)
This value is used when a financial transaction is included in a financial message
-
N (Not Required)
This value is set when a financial transaction is processed by the financial message creation activity but the financial transaction doesn’t have to be reported to the financial system. This happens when neither invoice information nor accounting detail information is present when creating the financial message.
-
S (superseded)
This value is set for financial transactions that have been superseded by the Supersede Transactions activity. Once this indicator is set, the financial transaction can be ignored by future executions of the supersede activity.
-
Fin Message Handled Datetime
This attribute is updated with the system date and time on which the financial message is created.
Financial Transaction Detail Process Data
-
Invoice Bulking Criteria This value is set to be able to retrieve the invoice id for this financial transaction detail
-
Invoice Line Bulking Criteria This value is set to be able to retrieve the invoice line id for this financial transaction detail
-
Accounting Bulking Criteria. This value is set to be able to retrieve the accounting detail id for this financial transaction detail This is required so that the invoices, invoice lines and accounting details (both invoiced and non-invoiced) can be traced back to the transactions that they originated from.
Base Financial Object
The status of the Base Financial Object that holds the financial transaction that is included in the financial message is updated to Financial Message Handled.
Financial Transaction Set
Whether or not the financial transaction set remains open depends:
-
if the Automatic Remove parameter is set to 'Y' or left unspecified, all financial transactions that are part of the financial transaction set and are not handled by the generate financial message activity are removed from the set and the status of the set becomes 'Closed'.
-
if the Automatic Remove parameter is set to 'N', no financial transactions are removed from the set. If at least one unhandled financial transaction is left, the status of the set remains 'Open', otherwise the status of the set becomes 'Closed'.
Financial Message Structure - XML
This structure is designed to support grouping of multiple financial transactions into a single financial message with invoices, invoice lines, and accounting details being totals of multiple transaction lines of multiple transactions within a message. This approach can greatly reduce the number of financial messages and invoices, invoice lines and accounting details within them that need to be handled by the financial system.
The process of creation of the XML is summarized by the image below:
The XSD holds two accounting details sections. The first top level section holds accounting details for non invoiced financial transaction details. The second level holds accounting details related to an invoice.
The top level structure of the financial message is as follows:
<financialMessage jobId="123"> ... -- see Financial Message section below for attributes <accountingDetails> <accountingDetail> <accountingDetailBulkingCriteria> ... </accountingDetailBulkingCriteria> ... -- see Accounting Detail section below for attr. </accountingDetail> -- refer to Accounting Detail section below for attributes … </accountingDetails> ... .... -- see Invoice section below for attributes ... .... -- see Invoice Line section below for attributes -- see Invoice Line section below for attributes … <accountingDetails> <accountingDetail> <accountingDetailBulkingCriteria> ... </accountingDetailBulkingCriteria> ... -- see Accounting Detail section below for attr. </accountingDetail> </accountingDetails> … </financialMessage>
The expected source of attributes in the element descriptions that follow is only an indication of what could be expected in a financial message. The expected source is indicated to give a more concrete image of the end-to-end payment flow. The actual source is determined during configuration and may depend on the configuration of the financial system. The actual values are set by the dynamic logic functions used in this activity. |
Financial Message Element
This element has attributes that relate to the financial message itself. Attributes in this XML element are all populated by fixed logic in the generate financial message activity. There is no dynamic logic function to manipulate the attribute values.
Element | Source of Value | Note |
---|---|---|
id |
Simple Sequence. |
Unique id of message generated by OHI. |
jobId |
Activity Id that created this financial message |
Unique id of the Financial Message Creation activity. |
messageDate |
System Date and time |
Date / Time the message was created. |
messageBulkingCriteria |
Financial Transaction Process Data.Fin Message Bulking Group |
Invoice Element
This element has attributes that hold identifying attributes at invoice header level. The source of value column indicates which attributes are expected to be used and what the expected source for them would be.
Element | Updatable in Dynamic Logic? | Source of Value | Note |
---|---|---|---|
invoiceBulkingCriteria |
|||
invoiceBulkingGroup |
No |
Financial Transaction Detail Process Data.Invoice Bulking Group |
Shows additional invoice bulking. Attribute may not contain a value. This value cannot be updated in the dynamic logic function. |
invoiceDestination |
No |
Financial Transaction Process Data.Invoice Destination |
Payable or Receivable |
counterpartyCode |
No |
Financial Transaction Detail Process Data.Counterparty Code |
Counterparty code is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
counterpartyQualifier |
No |
Financial Transaction Detail Process Data.Counterparty Qualifier |
Counterparty qualifier is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
payFromBankAccount |
No |
Financial Transaction Detail Process Data. Pay From Bank Account |
Pay from bank account is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function |
invoice attributes: |
|||
ohiInvoiceId |
No |
Sequence |
Unique identifier for OHI invoices generated by OHI. |
documentId |
Defaulted with OHI invoice Id but can be changed in the dynamic logic function. |
This will be used as invoice number in the financial system. The invoice number is defined in the dynamic logic function and is not validated in OHI. |
|
organization |
Organizational unit in which the invoice is accounted. Defined in dynamic logic. |
||
invoiceType |
Message generation logic. |
STANDARD if amount > 0 or 0 or CREDIT if amount < 0. |
|
invoiceDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
||
paymentBeneficiaryFlexCode |
Financial Transaction Detail Process Data.Payment Ben Flex Code Def Code |
If the Payment Beneficiary Flex Code Value is empty, the Counterparty qualifier value is used for this attribute. |
|
paymentBeneficiaryCode |
Financial Transaction Detail Process Data.Payment Beneficiary Code |
If the Payment Beneficiary Code is empty, the Counterparty Code is used for this attribute. |
|
currencyCode |
Financial Transaction Detail. Amount Curr |
||
invoiceAmount |
No |
Sum of all Financial Transaction Detail amounts included in the invoice. Negative for invoice type 'CREDIT'. |
|
paymentTerms |
Fixed 'IMMEDIATE' if invoicing being done just in time to meet due date. Otherwise, provided in dynamic field (determined upstream based on payment agreements with providers and general rules) |
||
description |
OHI Claims Adjudication |
Default value that can be overridden in dynamic logic |
|
source |
OHI CLAIMS |
Default value that can be overridden in dynamic logic |
|
invoiceCategory |
Defined in dynamic logic |
||
attribute1 .. attribute30 |
Free format elements for additional configuration defined attributes Defined in dynamic logic. |
Invoice Line Element
This element has attributes that hold identifying attributes at invoice line level. The source of value column indicates which attributes are expected to be used and what the expected source for them would be.
Element | Updatable in Dynamic Logic? | Source of Value | Note |
---|---|---|---|
invoiceLineBulkingCriteria |
|||
invoiceLineBulkingGroup |
No |
Financial Transaction Detail Process Data.Invoice Line Bulking Group |
Shows additional invoice line bulking. Attribute may not contain a value. This value cannot be updated in the dynamic logic function. |
reversal |
No |
Financial Transaction.Ind Reversal |
Reversal indicator is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
invoiceLine attributes: |
|||
ohiLineId |
No |
Sequence |
Unique identifier for OHI invoice lines generated by OHI. |
lineNumber |
Unique number within invoice. Used to ensure line number is unique for an invoice. |
||
lineType |
ITEM |
Defined in dynamic logic. |
|
amount |
No |
Financial Transaction Detail. Amount |
Sum of all Financial Transaction Detail amounts included in the invoice line. |
description |
OHI Claims Adjudication |
Default value that can be overridden in dynamic logic |
|
distributionAccount |
Financial Transaction Detail Process Data. General Ledger Account |
Default value that can be overridden in dynamic logic. |
|
attribute1 .. attribute30 |
Free format elements for additional configuration defined attributes. Defined in dynamic logic. |
Accounting Detail Element
This element has attributes that match the attributes of the Subledger to which the accounting details are exported.
Element | Updatable in Dynamic Logic? | Source of Value | Note |
---|---|---|---|
accountingDetailBulkingCriteria |
|||
accountingDetailBulkingGroup |
No |
Financial Transaction Detail Process Data.Accounting Bulking Group |
Shows additional accounting bulking. Attribute may not contain a value. This value cannot be updated in the dynamic logic function. |
reversal |
No |
Financial Transaction.Ind Reversal |
Reversal indicator is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
distributionAccount |
Financial Transaction Detail Process Data. General Ledger Account |
||
accountingDetail attributes: |
|||
ohiAccountingDetailId |
No |
Sequence |
Unique identifier for OHI accounting details generated by OHI. |
ledgerId |
Identification of the ledger to which the accounting details are interfaced. |
||
accountingDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
||
transactionDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
||
category |
Defined in dynamic logic. |
||
source |
Defined in dynamic logic. |
||
currencyCode |
Financial Transaction Detail. Amount Curr |
||
amountDebit |
No |
Financial Transaction Detail. Amount |
Sum of all Financial Transaction Detail amounts included in the accounting detail. This element is populated if the amount is a debit amount. |
amountCredit |
No |
Financial Transaction Detail. Amount |
Sum of all Financial Transaction Detail amounts included in the accounting detail. This element is populated if the amount is a credit amount |
description |
OHI Claims Adjudication |
Default value that can be overridden in dynamic logic |
|
accountingPeriod |
Defined in dynamic logic. |
||
glSegment1.. glSegment30 |
Financial Transaction Detail Process Data. General Ledger Account |
Mapping to the various GL accounting segments. Up to 30 segments are available to match the required chart of accounts structure. |
|
attribute1 .. attribute30 |
Free format elements for additional configuration defined attributes. Defined in dynamic logic. |
Financial Message Structure - Flat File
The system supports creation of the flat files that can be easily imported to Fusion Financial or other systems that have similar file structures
The process of creation of the flat files is summarized by the image below :
The file contents are driven by the dynamic logic functions. Each dynamic logic function takes in as input a combination of the relevant contexts - finanical message, Invoice, invoice line, accounting line detail and financial transaction detail. The contexts are described later in the section.
The function dynamic logic returns one or more rows along with the file details (file identifier and row content) to which they are required to be written. See function dynamic logic signature for details.
One data file is created for each distinct 'file identifier' found in any of the rows created by the dynamic logic functions during the activity processing. The rows with the same file identifier are written to it.
The order in which the rows of the financial message(s) for accounting details, invoice and invoice lines are written to the data file(s) is not configurable. |
Financial Message
This has attributes that relate to the financial message itself.
Element | Source of Value | Note |
---|---|---|
id |
Simple Sequence. |
Unique id of message generated by OHI. |
jobId |
Activity Id that created this financial message |
Unique id of the Financial Message Creation activity. |
messageDate |
System Date and time |
Date / Time the message was created. |
messageBulkingCriteria |
Financial Transaction Process Data.Fin Message Bulking Group |
Invoice
This has attributes that hold identifying attributes at invoice level.
Field | Source of Value | Note |
---|---|---|
invoiceBulkingGroup |
Financial Transaction Detail Process Data.Invoice Bulking Group |
Shows additional invoice bulking. Attribute may not contain a value. |
invoiceDestination |
Financial Transaction Process Data.Invoice Destination |
Payable or Receivable |
counterpartyCode |
Financial Transaction Detail Process Data.Counterparty Code |
|
counterpartyQualifier |
Financial Transaction Detail Process Data.Counterparty Qualifier |
|
payFromBankAccount |
Financial Transaction Detail Process Data. Pay From Bank Account |
|
ohiInvoiceId |
Sequence |
Unique identifier for OHI invoices generated by OHI. |
documentId |
Defaulted with OHI invoice Id |
|
invoiceDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
|
paymentBeneficiaryFlexCode |
Financial Transaction Detail Process Data.Payment Ben Flex Code Def Code |
If the Payment Beneficiary Flex Code Value is empty, the Counterparty qualifier value is used for this attribute. |
paymentBeneficiaryCode |
Financial Transaction Detail Process Data.Payment Beneficiary Code |
If the Payment Beneficiary Code is empty, the Counterparty Code is used for this attribute. |
currencyCode |
Financial Transaction Detail. Amount Curr |
|
invoiceAmount |
Sum of all Financial Transaction Detail amounts included in the invoice. Negative for invoice type 'CREDIT'. |
Invoice Line
This has attributes that hold identifying attributes at invoice line level.
Element | Source of Value | Note |
---|---|---|
invoiceLineBulkingGroup |
Financial Transaction Detail Process Data.Invoice Line Bulking Group |
Shows additional invoice line bulking. Attribute may not contain a value. |
reversal |
Financial Transaction.Ind Reversal |
Reversal indicator is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
ohiLineId |
Sequence |
Unique identifier for OHI invoice lines generated by OHI. |
lineNumber |
Unique number within invoice. Used to ensure line number is unique for an invoice. |
|
amount |
Financial Transaction Detail. Amount |
Sum of all Financial Transaction Detail amounts included in the invoice line. |
distributionAccount |
Financial Transaction Detail Process Data. General Ledger Account |
Accounting Detail
This element has attributes that match the attributes of the Subledger to which the accounting details are exported.
Element | Source of Value | Note |
---|---|---|
accountingDetailBulkingGroup |
Financial Transaction Detail Process Data.Accounting Bulking Group |
Shows additional accounting bulking. Attribute may not contain a value. |
reversal |
Financial Transaction.Ind Reversal |
Reversal indicator is a fixed grouping criterion for invoices. This value cannot be updated in the dynamic logic function. |
distributionAccount |
Financial Transaction Detail Process Data. General Ledger Account |
|
ohiAccountingDetailId |
Sequence |
Unique identifier for OHI accounting details generated by OHI. |
accountingDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
|
transactionDate |
Financial Transaction Process Data.Fin Message Handled Date Time |
|
currencyCode |
Financial Transaction Detail. Amount Curr |
|
amountDebit |
Financial Transaction Detail.Amount |
Sum of all Financial Transaction Detail amounts included in the accounting detail. This field is populated if the amount is a debit amount. |
amountCredit |
Financial Transaction Detail. Amount |
Sum of all Financial Transaction Detail amounts included in the accounting detail. This field is populated if the amount is a credit amount. |
Delivery of the Financial Messages
Generate Financial Message XML
The financial messages generated by the generate financial message xml activity type will be delivered to an external system depending on the value of the parameter Financial Message Delivery Option. The activity may result into multiple financial messages. For the delivery option 'Message Based'; these message will be individually delivered to the financial message endpoint through a message based delivery integration point as described in the Financial Message Integration Point in the Integration Guide. An activity message is logged in case a message cannot be delivered.
When the delivery option for the financial message is selected as 'File Based' then the system writes all the messages to an XML file (data file). The system might creates multiple XML files to avoid creation of large XML file with many financial message. These multiple files are placed in one data file set..The financial messages are delivered through the file based delivery integration point as described in the Financial Message Integration Point. Once a notification message is sent to an external system an activity message ACT-FL-DAFI-001 is logged.
Generate Financial Message Flat File
The financial messages generated by the generate financial message flat file based activity type are delivered through the file based delivery integration point. The system applies chunking of messages same as in generate financial message XML to avoid large files; for flat files a data file set is created per chunk. The data files are created per distinct 'file identifier' in the chunk.
FIN-FL-CRFM-002 is logged for each data file set that is created.
Error Message
The Generate Financial Message activity can result in the following messages with elementId attribute set to the claim code.
Code | Sev | Message |
---|---|---|
FIN-FL-CRFM-001 |
Informative |
Financial transactions for claim {code} are not processed because it would exceed the maximum amount. |
The message without elementId
Code | Sev | Message |
---|---|---|
FIN-VL-CRFM-001 |
Fatal |
The status of the financial transaction set must be Open |
FIN-VL-CRFM-002 |
Fatal |
Message creation for {message bulking group} failed |
FIN-VL-CRFM-004 |
Fatal |
Invalid signature for dynamic logic function {dyn logic code} |
FIN-VL-CRFM-005 |
Fatal |
The financial transaction set cannot be processed because of an active financial hold |
ACT-FL-DAFI-001 |
Informative |
Messages are written to the Data File Set(s) {comma separated list of data file set ids} |
*Note - Multiple data file sets are possible in case of generate financial message flat file