23 Financial Summary
The SPFS module is an application available in Supply Chain Hub. This chapter describes the implementation considerations and the operation details.
Implementation Overview
Financial Summary gives the possibility to share with suppliers visibility of their payment's status.
Configuration
This section describes Financial Summary configurations.
POM Configuration
Batch scheduler details with all batches, dependencies and frequencies can be downloaded following the steps in the Supply Chain Hub Frameworks section.
Other Cloud Services Configuration
This section describes implementation details that must be reviewed from an Oracle Retail Merchandising System perspective.
Other Implementation Considerations
This section describes Financial Summary implementation considerations.
Materialized Views
This application requires some results to be materialized in tables using the Materialized View Framework described in the Supply Chain Hub Frameworks section, below is the list for this application. Materialized Views used in Financial Summary are listed in this section.
ORCV_MV_SPFS_PAYMENT_BLNC
Description: To calculate and populate current balance to be displayed in Financial Summary Home. The Materialized View records contain the sum of all merchandise invoices and credit notes not associated with any Payment.
Pre-Dependencies: N/A
Post-Dependencies: N/A
Frequency: Ad-hoc
Codes
Certain operations require codes to define the options available at system level. Below you can find the list of code types available.
The codes are defined in the ORCV_CODE_HEAD and ORCV_CODE_DETAIL tables.
| CODE TYPE | CODE TYPE DESCRIPTION |
|---|---|
| FSDL | Dashboard Labels |
| FSDT | Document Type |
| FSPD | Payment Date |
References
Financial Summary also uses the Queries module to enable communication between retailer and supplier users, details about Queries are available in the Supply Chain Hub Frameworks section.
Operations
This section describes Financial Summary operations.
Integration by Module
Figure 23-3 Financial Summary Integration by Module
| STEP | DESCRIPTION |
|---|---|
| 0 | RSCH Data Access of MFCS data |
| 1 | Integration of Payments from External Financial System with to Financial Summary via Rest Service. |
Materialized Views Refresh Details
Materialized Views Refresh Details
ORCV_MV_SPFS_PAYMENT_BLNC
| PARAMETER | VALUE |
|---|---|
| Result Synonym | ORCV_MV_SPFS_PAYMENT_BLNC |
| Result Table A | ORCV_SPFS_PAYMENT_BLNC_A_R |
| Result Table B | ORCV_SPFS_PAYMENT_BLNC_B_R |
| Source View | ORCV_V_SPFS_PAYMENT_BLNC_R |
| Driving View | ORCV_V_SPFS_PAYMENT_BLNC_RC |
| Pre-Processor | ORCV_COMMON_MV_REFRESH.COMMON_PRE_PROCESSOR |
| Check Function | NA |
| Preserve Data | Y |
| Restart Indicator | N |
| Max Concurrent Threads | 4 |
| Filter Fields | SUPPLIER |
Service by Module
This section describes the Financial Summary services.
Payments Upload Service
This service uploads payments details of Financial Documents to Financial Summary. It will create the Payments and associated Documents in Financial Summary. In case the Payment ID already exists the service will overwrite the Payment and all its Documents.
Payment
| Payment | |
|---|---|
| Url Path | <BASE URL>/ords/mfcs/orcv/merch/financialsummary/subscription/payment |
| Request Method | PUT |
| Sample Request Body |
{ "payments": [ { "payment_id": "6", "supplier": "6200", "payment_date": "2024-05-15", "payment_method": "Bankr", "payment_details": "Account 345678", "taxable_amount": "34899", "payment_status": "A", "total_tax": "200", "documents": [ { "doc_id": "1", "doc_date": "2024-05-10", "doc_currency": "USD", "exchange_rate": "1.23", "doc_amount": "629800", "payment_amount": "629800", "total_tax": "9000", "payment_currency": "USD", "total_payment": "629800" }, { "doc_id": "2", "doc_date": "2024-05-10", "doc_currency": "USD", "exchange_rate": "1.23", "doc_amount": "629800", "payment_amount": "629800", "total_tax": "9000", "payment_currency": "USD", "total_payment": "629800", "doc_type": "MRCHI" }, { "doc_id": "3", "doc_date": "2024-03-11", "doc_currency": "USD", "exchange_rate": "1.23", "doc_amount": "32000", "payment_amount": "32000", "total_tax": "1000", "payment_currency": "USD", "total_payment": "32000" } ] } ] } |
| Sample Success Message |
Empty Response Code: 200 (Success) |
| Sample Failure Message |
{ "statusMsg": "Processed with error.", "errorMsg": "An error occurred while processing some records." } Response Code: 400 (Bad Request) |
| Affected Tables |
ORCV_SPFS_PAYMENT_DOC ORCV_SPFS_PAYMENT_HEAD ORCV_SPFS_SUB_PAYMENT_DOC ORCV_SPFS_SUB_PAYMENT_HEAD ORCV_SPFS_SUB_PAYMENT_HEAD_ERR |
Request Payload Details
| Element Name | Required | Data Type | Description |
|---|---|---|---|
| payments | Yes | Collection of Payment Object | List of payments. |
Payment Object
| Element Name | Required | Data Type | Description |
|---|---|---|---|
| payment_id | Yes | Number (10) | The Payment Id of the financial summary. |
| supplier | No | Number (10) | The Supplier id. |
| external_ref_id | No | Number (22) | External Reference Supplier ID. |
| payment_date | Yes | String (25) | Payment date in format defined in System Parameters DEFAULT_DATE_MASK. |
| payment_method | Yes | String (25) | The Payment payment method. |
| payment_details | Yes | String (256) | The Payment details. |
| taxable_amount | Yes | Number (20,4) | The taxable amount. |
| payment_status | Yes | String (1) | The payment status. |
| total_tax | Yes | Number (20,10) | The total tax value. |
| documents | No | Collection of Document Object | A list of documents associated with the Payment. |
Document Object
| Element Name | Required | Data Type | Description |
|---|---|---|---|
| doc_id | Yes | String (150) | The Document Id of the financial summary, doc_id must be unique. |
| doc_date | Yes | String (25) | Document date in format defined in System Parameters DEFAULT_DATE_MASK. |
| doc_type | Yes | String (6) | The Document Type, the valid values are defined in System Parameter SPFS_DOCT_TYPE |
| doc_currency | Yes | String (3) | The Document currency in MFCS format |
| exchange_rate | Yes | Number (20,10) | The Document Exchange rate. |
| doc_amount | Yes | Number (20,4) | The Document Amount. |
| payment_amount | Yes | Number (20,4) | The Payment Amount. |
| total_tax | Yes | Number (20,10) | The Document Total Tax. |
| payment_currency | Yes | String (3) | The Payment currency. |
| total_payment | Yes | Number (20,4) | The Payment total in Payment currency. |