Search Results get_invoice_format

Overview

OKL_INTERNAL_BILLING_PVT is a private (PVT classification) PL/SQL package owned by the APPS schema in Oracle E-Business Suite, forming part of the Oracle Lease Management (OKL) module within the ETRM product family. Its primary business function is to support the generation, maintenance, and accounting treatment of internal billing transactions — specifically invoice and receivable records created when lease contracts generate internal charges. The package header declares a consistent set of global constants inherited from OKL_API, including G_RET_STS_SUCCESS, G_RET_STS_ERROR, and G_RET_STS_UNEXP_ERROR, establishing adherence to the standard Oracle EBS API error-handling convention. It also defines custom exceptions such as G_EXCEPTION_HALT_VALIDATION together with standard tokens (G_SQLERRM_TOKEN, G_SQLCODE_TOKEN, G_COL_NAME_TOKEN) used for returning user-facing error messages.

Because it is classified as a private package, its procedures are not intended as a public integration interface. Instead, it is consumed internally by the OKL internal billing and accounting engine, and the metadata confirms it is referenced by 17 other packages, underscoring its role as a shared internal service layer.

Key Procedures and Functions

The package exposes five documented procedures/functions:

• CREATE_BILLING_TRX — The core routine for creating an internal billing transaction. It builds the invoice and receivable line data, populating the AR invoice and line tables used by Lease Management for internal billing.
• GET_INVOICE_FORMAT — Retrieves the invoice format configuration used when constructing billing transactions.
• UPDATE_MANUAL_INVOICE — Updates a manually entered internal invoice, allowing corrections or adjustments to billing data.
• DELETE_MANUAL_INVOICE — Removes a manually entered invoice from the internal billing records.
• CREATE_ACCOUNTING_DIST — Generates the accounting distributions associated with the billing transaction, feeding the subledger accounting process.

No parameter signatures are documented in the source excerpt; the procedures are therefore described by purpose only.

Tables Accessed

The package reads and writes through APPS synonyms across several functional areas:

• Billing and invoice tables: OKL_TRX_AR_INVOICES_B, OKL_TXL_AR_INV_LNS_B, and OKL_TXD_AR_LN_DTLS_B store the header, line, and detail records for internal AR invoices.
• Receivables setup tables: AR_RECEIPT_CLASSES, AR_RECEIPT_METHODS, RA_CUST_RECEIPT_METHODS, RA_TERMS_B, and RA_TERMS_TL supply receipt class, method, and payment term defaults applied to the generated invoices.
• Contract and rule data: OKC_K_HEADERS_B, OKC_K_PARTY_ROLES_B, OKC_RG_PARTY_ROLES, OKC_RULES_B, and OKC_RULE_GROUPS_B provide contract header, party role, and rule information that drives billing logic.
• Reference and profile data: FND_CURRENCIES and HZ_CUSTOMER_PROFILES supply currency and customer profile attributes used during transaction construction.

Usage Notes

As a private package, OKL_INTERNAL_BILLING_PVT is not called directly from standard EBS forms or concurrent program parameters. It is invoked by other OKL packages — consistent with the metadata showing 17 referencing packages — during internal billing runs, invoice generation, and manual invoice maintenance. Its exception structure and API-standard return statuses make it suitable for orchestration by higher-level public APIs, where errors are propagated through the G_RET_STS_* constants and message tokens. Custom code should only call this package while respecting the same error-handling conventions, and developers should note that the header references 12.1.1 (120.1) lineage while the documented metadata corresponds to 12.2.2.