Search Results fv_federal_payment_fields_pkg




Overview
Explore in AI Chat

Overview

FV_FEDERAL_PAYMENT_FIELDS_PKG is an Oracle E-Business Suite (EBS) PL/SQL package body owned by the APPS schema that supports federal payment processing within the U.S. Federal Financials (FV) module. Its primary responsibility is to derive and populate the federal payment attributes required on payment instructions and summary records, including Treasury agency codes, FEIN identifiers, allotment codes, and Treasury Offset Program (TOP) eligibility indicators. The package operates at the intersection of Oracle Payables, Oracle Payments, and federal Treasury reporting, bridging invoice-level and supplier-level data with the payment instruction records stored in the IBY tables. It is classified as an OTHER API in ETRM 12.2.2, meaning it is an internal utility rather than a formally published public API, and it is referenced by four other packages within the Federal Financials product family. The package is heavily dependent on the FND API, message, logging, and file utility stacks (FND_API, FND_MSG_PUB, FND_LOG, FND_FILE, FND_MESSAGE, FND_GLOBAL, FND_PROFILE, FND_REQUEST, FND_FLEX_EXT), as well as MO_GLOBAL and MO_UTILS for multi-org context handling, confirming its role as a supporting backend engine rather than a user-facing entry point.

Key Procedures and Functions

  • GET_FEIN — Retrieves the Federal Employer Identification Number associated with a supplier or payment record, used on federal payment instruction output.
  • GET_ABBREVIATED_AGENCY_CODE — Returns the abbreviated Treasury agency code required for federal payment formatting.
  • GET_ALLOTMENT_CODE — Derives the allotment code applicable to a payment, drawing on flexfield and operating unit context.
  • TOP_OFFSET_ELIGIBILITY_FLAG — Determines whether a payment is eligible for offset under the Treasury Offset Program, based on exclusion criteria configuration.
  • GET_PAY_INSTR_SEQ_NUM — Generates or retrieves the payment instruction sequence number used to group and identify federal payment instructions.
  • SUMMARY_FORMAT_PROG_COMPLETED — Callback used to evaluate or signal completion of the summary formatting concurrent program.
  • SUBMIT_PAY_INSTR_TS_REPORT — Submits the Treasury Schedule (TS) payment instruction report via FND_REQUEST.
  • SUBMIT_CASH_POS_REPORT — Submits the Cash Position report, another mandatory federal Treasury submission.
  • LOG_ERROR_MESSAGES — Centralized error handling routine that pushes messages onto the FND message stack and writes to the FND log.

Tables Accessed

The package reads and writes across the Payables, Payments, and Federal Financials schemas via APPS synonyms. Invoice and distribution data are sourced from AP_INVOICES_ALL and AP_INVOICE_DISTRIBUTIONS, with supplier identification from AP_SUPPLIERS via IBY_DOCS_PAYABLE_ALL. Payment instruction and payment records are handled through IBY_PAY_INSTRUCTIONS_ALL and IBY_PAYMENTS_ALL. Federal-specific configuration is pulled from FV_OPERATING_UNITS_ALL, FV_PB_SEQ_ASSIGNMENTS_ALL, FV_SUMMARY_CONSOLIDATE_ALL, FV_TOP_EXCLUSION_CRITERIA, and FV_TOP_EXCLUSION_CRITERIA_ALL, governing agency mapping, sequence assignment, summary consolidation, and TOP offset exclusion logic. GL_LEDGERS supplies ledger context, and PLITBLM supports PL/SQL table operations.

Usage Notes

FV_FEDERAL_PAYMENT_FIELDS_PKG is typically invoked indirectly through federal payment instruction formatting and Treasury reporting concurrent programs, and by the four dependent packages that call its utility routines. Direct custom invocation is not recommended, as the API is classified OTHER and lacks a documented public interface. Customers integrating custom federal payment extensions should call the GET_* functions only within an initialized FND_GLOBAL and MO_GLOBAL session context, and rely on LOG_ERROR_MESSAGES for consistent error propagation. Behavior is consistent across EBS 12.1.1 and 12.2.2.