Results for “create_writeoffs”

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

Overview

IEX_WRITEOFFS_PVT is a private PL/SQL API package in the Oracle E-Business Suite Collections (Advanced Collections / IEX) module. Its business purpose is to manage the lifecycle of write-off records — the adjustments that remove uncollectible or immaterial receivables balances from a customer account without applying a payment or credit memo. A write-off is the accounting mechanism by which a collections organization formally closes a delinquent transaction rather than pursuing further collection activity, and this package provides the programmatic interface through which such records are created, maintained, and removed.

The package is classified as PVT (private) within the ETRM API classification scheme. This designation indicates that it is intended as an internal implementation layer rather than a supported public interface; the public or wrapper APIs in the IEX schema are expected to call IEX_WRITEOFFS_PVT rather than external callers invoking it directly. The source header identifies the package as IEX_writeoffs_PVT with the file name iexvwrob.pls and the internal package constant G_PKG_NAME set to 'IEX_WRITEOFFS_PVT'. Debug logging is controlled through PG_DEBUG, initialized from FND_LOG.G_CURRENT_RUNTIME_LEVEL, allowing diagnostic output through the IEX debug utilities when the runtime logging level permits.

Key Procedures and Functions

The documented package exposes three procedures:

• CREATE_WRITEOFFS — Inserts a new write-off record into the IEX_WRITEOFFS table. It operates under the standard Oracle EBS API savepoint convention (the source declares SAVEPOINT CREATE_WRITEOFFS_PVT), performs an API compatibility check via FND_API.Compatible_API_Call, and returns the newly generated primary key writeoff_id through an OUT parameter. The implementation obtains the key from the IEX_WRITEOFFS_S sequence. It supports the standard API message-list, validation-level, and commit-control parameters.
• UPDATE_WRITEOFFS — Modifies an existing write-off record, applying the same API framework conventions (savepoint, compatibility check, message list, and optional commit) as the create routine. It is used to maintain attributes of a write-off after initial creation.
• DELETE_WRITEOFFS — Removes a write-off record. This is the procedure most commonly associated with the search term delete_writeoffs. Callers typically invoke it to reverse an incorrectly entered write-off before it has been reconciled or posted, or to clean up obsolete records during data correction. As with the other routines, it adheres to the FND_API error-handling model, returning status and message information through the standard OUT parameters.

No parameter lists are documented for UPDATE_WRITEOFFS or DELETE_WRITEOFFS in the available metadata; only CREATE_WRITEOFFS exposes a parameter signature. The procedures are not documented as functions, and no separate validation or query routines are listed.

Tables Accessed

• IEX_WRITEOFFS — The primary transactional table holding write-off records. The package reads from it (for example, to resolve writeoff_id, object_version_number, and active_flag during processing) and writes to it via insert, update, and delete operations.
• IEX_WRITEOFFS_S — The sequence supplying unique primary key values for new write-off records. The source contains a cursor c2 selecting IEX_WRITEOFFS_S.nextval from dual, which CREATE_WRITEOFFS uses to populate the writeoff_id.
• DUAL — Used solely as the source for sequence NEXTVAL retrieval.

Usage Notes

IEX_WRITEOFFS_PVT is normally invoked indirectly. Within Oracle EBS 12.1.1 and 12.2.2, the Collections write-off user interface — the Write-Offs form and related Collections workbench actions — calls into the IEX write-off API layer, which in turn delegates to this private package. The package is referenced by two other packages in the documented metadata, confirming that it functions as a shared internal service rather than a standalone entry point.

Because the package is classified PVT, direct calls from custom code are generally discouraged; extensions should use the corresponding public API whenever one is available. When the package is called, it follows the standard Oracle EBS API contract: callers should supply P_Init_Msg_List, P_Commit, and P_Validation_Level, then inspect X_Return_Status, X_Msg_Count, and X_Msg_Data for outcomes. Commit behavior is controlled by the caller, so transactions can be composed across multiple API calls before a final commit or rollback. Debug output can be enabled through the IEX logging profile and the FND_LOG runtime level, which is useful when troubleshooting failed create, update, or delete_writeoffs operations.