Results for “move_to_history”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

The APPS.IGI_CIS2007_IGIPMTHR_PKG package body is a component of the Oracle E-Business Suite UK Construction Industry Scheme (CIS) 2007 localization. Its primary business function is to support the generation and management of the monthly CIS return — specifically the Contractor's Monthly Return (form CIS300) that a UK contractor is legally obliged to file with HM Revenue & Customs in respect of payments made to subcontractors. The package is responsible for gathering the population of CIS-enabled suppliers for a given reporting period, extracting the payment and deduction details associated with each, building the monthly return header and line data, and managing the archival of that return data once it has been produced.

The package is classified as a back-end PL/SQL object with an API classification of OTHER; it is not a public, versioned open interface but rather an internal processing unit invoked by the CIS monthly return process. The header comment confirms it is a maintained object (last updated under version 120.19.12020000.7), and it includes a standard FND logging framework with procedures to write statement, procedure, event, exception, error, and unexpected messages to the FND_LOG repository.

Key Procedures and Functions

The metadata documents five procedures within the package:

• POPULATE_VENDORS — Selects the CIS-enabled suppliers that fall within the requested range and period, and returns the count of qualifying rows. This drives the set of subcontractors that will appear on the monthly return.
• GET_PAYMENT_CIS_DETAILS — Retrieves the payment and CIS deduction detail for the selected vendors, forming the core financial data set for the return.
• POPULATE_MTH_RET_DETAILS — Assembles the monthly return header and line data from the gather stages into the CIS return tables.
• MOVE_TO_HISTORY — Transfers completed return data into the history/archive tables, preserving the record of filed returns.
• RUN_MTH_RET_REPORT — Drives the monthly return reporting activity, coordinating the gather, populate, and archival steps and producing the return output.

All procedures are enclosed in a package that also exposes an init procedure and a private log procedure used for FND debug messaging. Parameter lists are not reproduced here, as the documented metadata describes purpose only.

Tables Accessed

The package reads and writes a combination of Oracle Payables base tables and CIS-specific localization tables, accessed through APPS synonyms:

• Supplier and address data: AP_SUPPLIERS, AP_SUPPLIER_SITES, AP_REPORTING_ENTITIES — used to identify CIS-enabled subcontractors and their reporting entities.
• Payment and invoice data: AP_CHECKS, AP_INVOICES, AP_INVOICES_ALL, AP_INVOICE_DISTRIBUTIONS, AP_INVOICE_PAYMENTS — the source of gross payments and payment dates used to compute CIS deductions.
• Tax and period data: AP_TAX_CODES_ALL, AP_AWT_TAX_RATES_ALL, AP_OTHER_PERIODS — used to determine the applicable deduction rates (verified, unverified, gross) and the correct monthly reporting period.
• CIS monthly return tables: IGI_CIS_MTH_RET_HDR_H, IGI_CIS_MTH_RET_HDR_T, IGI_CIS_MTH_RET_HDR_T_S, IGI_CIS_MTH_RET_LINES_H — the header, temporary, and lines structures that hold the return before archival and after transfer to history.

Usage Notes

This package is typically invoked from the CIS monthly return processing flow rather than being called directly by end users. In a standard Oracle EBS 12.1.1 or 12.2.2 instance, it is driven by the associated CIS monthly return concurrent program or by the CIS2007 localization setup, with the calling process supplying the vendor range and reporting period. Because the package is not referenced by any other documented package (referenced-by count is zero), it functions as a top-level localization processing unit. The presence of the RUN_MTH_RET_REPORT procedure indicates that report generation is coordinated in the same package. The MOVE_TO_HISTORY and history table references (the _H suffix tables) confirm that the design separates live return staging from archived, filed returns. Developers extending the CIS2007 functionality should treat this package as internal and invoke it only through the supported monthly return process; direct modification is not advisable because the object is shipped and maintained by Oracle under the localization patch stream. FND logging can be enabled via the standard profile to aid diagnosis of return-generation problems.