Results for “okl_terms_interface”

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

Overview

OKL_TERMS_INTERFACE is a staging and interface-rules table within the Oracle Lease and Finance Management (OKL) module of Oracle E-Business Suite. As documented in the ETRM repository for releases 12.1.1 and 12.2.2, the object is described as the "Contracts Open Terms Interface Rules Table." It operates in the OKL schema alongside the core contract and terms tables, serving as the inbound staging surface through which open (mid-term) contract terms are accepted, validated, and subsequently applied to lease and loan agreements. Because lease contracts frequently require amendments — changes to billing addresses, bank accounts, invoice review requirements, payment methods, and cash application rules — this interface table captures the incoming values for those attributes before the concurrent interface program moves them into the production contract structures.

The table is physically owned by OKL and contains 18 documented columns in the 12.2.2 data model. Heuristic Data Vault classification mined from the foreign-key structure identifies this object as standalone, meaning it exhibits no parent-hub dependencies through its FK graph and is best modeled as an independent staging or reference structure rather than a hub, link, or satellite. This classification is a modeling suggestion only; functionally the table behaves as an interface staging entity.

Key Information Stored

The most operationally significant columns fall into three groups: contract identifiers, financial/billing attributes, and review-control attributes.

• CONTRACT_NUMBER_OLD — the business identifier of the lease or loan contract whose open terms are being supplied or amended. This is the principal business-key candidate for joining back to contract header tables.
• LINE_NUMBER — identifies the specific contract line to which the incoming term values apply, enabling line-level rather than header-level updates.
• BILL_TO_ADDRESS_ID / BILL_TO_ADDRESS — the numeric identifier and descriptive address used for billing; the ID is the foreign-key-style reference while the address column carries the printable value.
• BANK_ACCOUNT_ID / BANK_ACCOUNT_NUMBER — the payer or remittance bank account identifier and its display number, used when collections are directed to a specific account.
• PAYMENT_METHOD_ID / PAYMENT_METHOD — the payment instrument (for example, ACH, wire, or check) expressed as both an ID and a code.
• INVOICE_FORMAT_ID / INVOICE_FORMAT_CODE — the invoice presentation format; INVOICE_FORMAT_ID carries a documented foreign key to PA_INVOICE_FORMATS.
• REVIEW_INVOICE_FLAG — a control flag indicating whether invoices from this contract require manual review.
• REASON_FOR_INVOICE_REVIEW and INVOICE_REVIEW_UNTIL_DATE — the justification text and the date through which invoice review is enforced.
• PRESCRIBED_ASSET_FLAG — indicates whether the contract is tied to a prescribed asset.
• CASH_APPL_RULE_NAME — the named cash application rule used to apply receipts against the contract.
• SCREEN_SECTION_NAME, SCREEN_FIELD_LABEL, SCREEN_FIELD_VALUE — a generic name/value triplet that lets the interface carry UI-oriented field context for flexible, section-based term updates.

The documented schema does not expose a single named surrogate primary key column; CONTRACT_NUMBER_OLD combined with LINE_NUMBER and a screen-field identifier forms the practical business key for staging rows.

Common Use Cases and Queries

Typical usage centers on pre-interface validation and post-interface reconciliation reporting. Analysts frequently verify that every staged contract number resolves to a live agreement before running the interface concurrent program.

• Identify contracts awaiting term updates: SELECT CONTRACT_NUMBER_OLD, LINE_NUMBER, PAYMENT_METHOD, CASH_APPL_RULE_NAME FROM OKL.OKL_TERMS_INTERFACE WHERE CONTRACT_NUMBER_OLD IS NOT NULL;
• Report contracts flagged for invoice review: SELECT CONTRACT_NUMBER_OLD, REASON_FOR_INVOICE_REVIEW, INVOICE_REVIEW_UNTIL_DATE FROM OKL.OKL_TERMS_INTERFACE WHERE REVIEW_INVOICE_FLAG = 'Y';
• Join to invoice formats to confirm valid format assignment: SELECT t.CONTRACT_NUMBER_OLD, p.INVOICE_FORMAT_NAME FROM OKL.OKL_TERMS_INTERFACE t, PA.PA_INVOICE_FORMATS p WHERE t.INVOICE_FORMAT_ID = p.INVOICE_FORMAT_ID;
• Review screen-driven field values for a given section: SELECT SCREEN_SECTION_NAME, SCREEN_FIELD_LABEL, SCREEN_FIELD_VALUE FROM OKL.OKL_TERMS_INTERFACE WHERE CONTRACT_NUMBER_OLD = :contract;

These patterns support audit, data-quality checks, and troubleshooting when interface runs reject or partially apply staged rows.

Related Objects

The documented foreign-key relationship links INVOICE_FORMAT_ID to PA_INVOICE_FORMATS in the Payables schema, making that the primary referenced object. Beyond this, the interface logically integrates with the following OKL and shared structures:

• PA_INVOICE_FORMATS — joined via OKL_TERMS_INTERFACE.INVOICE_FORMAT_ID = PA_INVOICE_FORMATS.INVOICE_FORMAT_ID.
• OKL_CONTRACTS / OKL_CONTRACT_HEADERS — matched on CONTRACT_NUMBER_OLD for contract validation.
• OKL_CONTRACT_LINES — matched on LINE_NUMBER for line-level term application.
• OKL_TERMS / OKL_TERMS_TL — the production term tables populated by the interface program.
• OKL_BILLING_SCHEDULES and OKL_INVOICES — downstream consumers of billing address, invoice format, and review attributes.
• OKL_CASH_APPLICATION_RULES (or AR receipt application rules) — resolved through CASH_APPL_RULE_NAME.
• OKL_PAYMENT_METHODS / AR lookup values — resolved through PAYMENT_METHOD_ID and PAYMENT_METHOD.

Collectively these relationships confirm the table's role as a transitional staging layer feeding the authoritative lease contract and billing data model.