Generate Report for Account Reconciliation

Generates either a single predefined Reconciliation Compliance report, predefined Transaction Matching report or a custom report.

This API is version v1.

Note:

All parameters must be specified for a report.

REST Resource

POST       /arm/rest/fcmapi/{api_version}/report

Request

Example of request body

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 9-1 REPORT

Name Description Path Required
api_version Version of the API you are working with. This release is v1 Yes Yes
groupName The name of the group the report is associated with. Yes Yes
reportName The name of the report to be generated. For example, for predefined reports, see the list of Reconciliation Compliance or Transaction Matching reports:List of Reconciliation Compliance Predefined Reports and Parametersor Transaction Matching Predefined Reports and Parameters Yes Yes
generatedReportFileName The name specified by the user of the report to be generated. If this parameter is not provided, then the report will get generated with the data for reportName parameter in this table. No No
parameters In this example, the parameter is periodName, which is the name of the period, such as June 2018.

Each report may have different parameters. Check the parameters in the table provided for Reconciliation Compliance or Transaction Matching predefined reports.

No No
format The format of the report (HTML, PDF, XLS, XLSX, or CSV). Yes No (default is PDF)
module The module within Account Reconciliation: RC (Reconciliation Compliance) or TM (Transaction Matching. Yes No (default is RC)
emails Comma separated list of email addresses that will receive the report. No No
{
"groupName":"Reconciliation Manager",
"reportName":"Balance by Account Type",
"generatedReportFileName":"myReport.pdf",
 "parameters":{"Period":"June 2018","Currency Bucket": "Entered", "Rate Type": "Accounting"},
"format":"PDF",
"module":"RC",
"emails":"user1@oracle.com,user2@oracle.com"
}

Response

Examples of Response Body

Supported Media Types: application/json

Parameters:

Table 9-2 Parameters

Name Description
details In case of errors, details are published with the error string
status See Migration Status Codes
links Detailed information about the link
href Links to the API call
action The HTTP call type
rel Relationship type (self, Job Status). if set to Job Status, you can use the href to get the status of the operation
data Parameters as key value pairs passed in the request

The following is an example of the response body in JSON format for a Reconciliation Compliance report called My Report in pdf format:

{
"type":"RC",
"status":0,
 "details": "myReport.pdf",
 "links" [{
 "action": "POST",
  "href":  "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com:9000/fcm/rest/fcmapi/v1/report",
  "rel":  "self"
  },
       {
            "rel": "report-content",
            "href": "https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com:9000/interop/rest/v1/applicationsnapshots/myReport.pdf",
            "action": "GET"
}
]

List of Reconciliation Compliance Predefined Reports and Parameters

The following table describes each predefined report for Reconciliation Compliance and the required parameters.

Report Description Required Parameters
Balance by Account Type

Displays key reconciliation metrics grouped by account type.

  • Period––Determines which period’s data is used.

  • Currency bucket––Determines which currency bucket data should be selected from for each of the currency amounts.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency values should be translated to.

  • Optional: Risk Rating––Allows users to filter by risk rating.

Balance by Organizational Unit

Displays key reconciliation metrics grouped by organizational unit.

  • Period––Determines which period’s data is used.

  • Currency bucket––Determines which currency bucket data should be selected from for each currency amount.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency values should be translated to.

  • Optional: Risk Rating––Filter by risk rating.

Reconciliation Compliance Analysis

Displays key compliance metrics by user.

  • Period––Data is displayed only for the selected period.

  • Optional: Minimum % Late––Enable the users to provide a threshold that filters the records to be displayed. For example, if the user enters 10, only users with 10% or more of their reconciliations completed late are displayed in the report.

Invalid Profiles

Displays invalid profiles and the reasons the profile is invalid. Because a profile may be invalid for multiple reasons, the same profile may be listed more than one time in the report.

N/A

Late Reconciliations

Displays reconciliations that are currently late for either the preparer role or for any reviewer level role.

Period––Data is displayed only for the selected period.

Missing Reconciliations

Displays profiles that should exist in the period but do not exist (either because they were not copied to the period, or because they were copied and deleted). “Should Exist” is determined based on the frequency of the profile matching the frequency of the period.

Period––Data is displayed only for the selected period.

Open Reconciliations Aging Analysis Analyzes the lateness of reconciliations that are still open (status not equal to closed). Only reconciliations that are not closed are included in the report, and lateness is analyzed using the reconciliation End Date (the due date associated with the last workflow role). Any reconciliation that is open, and the End Date is before the report run date, is included.

The report is comprised of the following sections:

  • All Periods: Displays the metrics associated with all periods that have qualifying reconciliations.

  • By Period: For each period with qualifying reconciliations, displays a separate section displaying the metrics for that period.

  • Currency bucket––Determines which currency bucket data should be selected from.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency code the values should be translated to.

  • Optional: Account Type––Determines which Account Types to display.

Reconciliation Performance Analysis by Organizational Unit

Displays key compliance metrics by Organizational unit. A reconciliation is counted once for each workflow role assigned to the reconciliation, and the most recent workflow action “wins”. For example, if a reconciliation is prepared twice (because it was rejected after the first certification), then the second certification is included in the metrics.

Period––Data is displayed only for the selected period.

Profile Audit Trial

Displays the changes made to profiles during a user selected date range.

  • From Date––The starting date.

  • To Date––The ending date.

  • Optional: Changed By––Enables the user to select records changed by the selected user.

  • Optional: Field Changed––Enables the user to select changes made to a field.

  • Optional: Account ID––Enables the user to select changes made to an account.

Reconciliation Audit Trail

Displays the changes made to reconciliations during a user selected date range.

  • From Date––The starting date.

  • To Date––The ending date.

  • Optional: Changed By––Enables the user to select records changed by the selected user.

  • Optional: Field Changed––Enables the user to select changes made to a specific field.

  • Optional: Account ID––Enables the user to select changes made to a specific account.

Reconciliation Result

Presents an analysis of the magnitude of the Source System Balance in three categories:

  • Fully Reconciled—Reconciliation status is Closed, and there are no Adjustments to Source System

  • Reconciled with Open Items—Reconciliation status is Closed, but Adjustments to Source System is not zero

  • Unreconciled—Reconciliation status is not equal to Closed

  • Period––Determines which period’s data is used.

  • Currency bucket––Determines which currency bucket data should be selected from for each of the currency amounts.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency values should be translated to.

  • Optional: Account Segment 1 & Account Segment 2––Filter by Account Segment 1 or Account Segment 2. If you need additional segments for filtering, modify the report.

  • Optional: Risk Rating––Filter by Risk Rating.

Reconciliation Trend Analysis

Displays a line chart reflecting the value of a selected reconciliation balance attribute over a range of twelve periods.

  • Period––Determines which period’s data is used.

  • Account ID

  • Attribute––Select one attribute:

    Source System Balance, Subsystem Balance, Adjustments to Source System, Adjustments to Subsystem, Unexplained Difference, Late Reconciliations, Late Preparations Late Reviews.

  • Currency Bucket––Determines which currency bucket data should be selected from.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency code the values should be translated to.

Rejected Reconciliation

Displays the list of reconciliations that were rejected by any reviewer level role.

Period––Determines which period’s data is used.

Transaction Aging Analysis

Displays a pie chart reflecting the count and value of selected reconciliation transactions, grouped by aging bucket.

  • Period––Determines which period’s data is used.

  • Transaction Type––Select which transaction type to report (Adjustments to Source System, Adjustments to Subsystem, or Balance Explanations).

  • Aging Profile––Enables you to determine which aging profile to use when plotting the transactions in the chart.

  • Currency bucket––Determines which currency bucket data should be selected from.

  • Rate Type––Determines which rate type to use in the currency translation calculation.

  • Currency––Determines which currency code the values should be translated to.

Users with Late Reconciliations

Displays the count of reconciliations that are late for either the preparer role or for any reviewer level role, grouped by user name.

Period––Determines which period’s data is used.

Additional Predefined Reports Provided in Sample Application

In the Sample Application, there are three categories (or report groups) containing predefined reports:

  • Compliance Reporting
  • Reconciliation Manager (these are the same predefined reports as outlined above)
  • Variance Analysis

Table 9-3 Compliance Reporting Report Group - Required Parameters

Report Required Parameters
Large Unexplained Difference

Period––Determines which period’s data is used.

Aging Violations

Period––Determines which period’s data is used.

IC Unbalanced

Period––Determines which period’s data is used.

Warnings

Period––Determines which period’s data is used.

Table 9-4 Variance Analysis Report Group - Required Parameters

Report Required Parameters
Variance Analysis Detailed

Period––Determines which period’s data is used.

Variance Analysis Summary

Period––Determines which period’s data is used.

Transaction Matching Predefined Reports and Parameters

Report Description Required Parameters
Reconciliation Configuration

Displays the list of reconciliations and the configuration assigned to each.

Fields on this report include: reconciliation ID, name and match type name, preparer name, and description.

  • Name––The name of the generated report zip file.

  • Profile––Optional: Choose a profile from the drop-down list of values.

  • Match Type––Optional:Choose a type from the drop-down list of values.

  • Optional: Preparer––Optionally select a preparer.

Reconciliation (Match) Type Configuration

Displays the list of match types and the configuration assigned to each.

Fields on this report include: match type ID, name, and description, calendar name, status, number of match processes, number of data sources, source systems and sub systems, format name, and count of rules.

If multiple data sources are used as source systems and sub systems, all will be listed.

  • Name––The name of the generated report zip file.

  • Optional: Match Type––Choose a type from the drop-down list of values. If a Match Type is not selected, all match types are reported.

  • Calendar––Choose a calendar time period (i.e. monthly).

  • Status––Choose a status from the list of valid values (i.e. Approved or Pending).

  • Number of Match Processes––Displays the number of match processes.
  • Number of Data Sources––Displays the number of data sources.
  • Format––Choose a format from the list of valid values (i.e. Account Analysis or Balance Comparison).

  • Number of Rules––Displays the number of rules from all match processes.
Closed Adjustments

Displays the list of adjustments with a status of Closed.

Fields displayed on report include transaction type, id and description, source, and amount.

  • Name––The name of the generated report zip file.

  • Reconciliation––Choose a reconciliation from the drop-down list of values.

  • Reconciliation Type––Choose a type from the drop-down list of values.

Open Adjustments

Displays the list of adjustments with a status of Open.

Fields displayed on report include transaction type, id, name, description, source, and amount.

  • Name––The name of the generated report zip file.

  • Reconciliation––Choose a reconciliation from the drop-down list of values.

  • Reconciliation Type––Choose a type from the drop-down list of values.

Reconciliation Status

Displays the status of reconciliations, in terms of count of unmatched transactions, count of supported transactions, and count of open adjustments.

The unmatched transactions, supported transactions, and open adjustments are from all sources irrespective of match process.

  • Name––The name of the generated report zip file.

  • Profile––Choose a profile from the list of valid values.

  • Match Type––Choose a match type from the list of valid values.

Supported Transactions

Displays the list of reconciliations that have supported transactions.

Fields include: reconciliation ID, name, transaction type, transaction ID, name, and description, source, amount, and number of transactions.

  • Name––The name of the generated report zip file.

  • Optional: Reconciliation––Choose a reconciliation from the list of valid values.

  • Optional: Match Type––Choose a match type from the list of valid values.

Custom Report Parameters

Use this table of parameters if you want to generate a custom report.

Name Description Path Required
groupName The name of the group the report is associated with. Yes Yes
reportName The name of the report to be generated. Yes Yes
generatedReportFileName The name specified by the user of the report to be generated. If this parameter is not provided, then the report will get generated with the data for reportName parameter in this table. No No
parameters Types of parameters:
  • Numerical - should be in BigDecimal format.
  • Text - standard string
  • Date - should be in format YYYY-MM-dd
  • Boolean
  • Users - user login ID
  • List of choices - case insensitive values
No No
format The format of the report (HTML, PDF, XLS, XLSX, or CSV). Yes No (default is PDF)
module The module within Account Reconciliation: RC (Reconciliation Compliance) or TM (Transaction Matching. Yes No (default is RC)
emails Comma separated list of email addresses that will receive the report. No No