Search Results ar_autorem_api

Overview

The concurrent program AUTOREMAPI belongs to the Oracle Receivables (AR) module and is presented to end users under the name Automatic Remittances Creation Program (API). Its description in the Electronic Technical Reference Manual (ETRM) identifies it simply as the “Automatic Remittances Creation Program,” and the executable name (AR_AUTOREM_API) confirms that its logic is exposed through the Receivables automatic remittance application programming interface rather than through a forms-driven window.

In Oracle Receivables, a remittance is the record that associates a batch of receipts (typically entered, imported, or applied by an external process) with their expected deposit to the bank. The Automatic Remittances Creation Program (API) provides a concurrent, set-based mechanism for creating these remittance records programmatically. It is particularly relevant in environments where receipts originate from external or high-volume sources — for example, lockbox, credit card, or third-party integration feeds — and where the automatic remittance batch cannot be assembled interactively. The program is documented as enabled (Enabled: Yes) in the 12.2.2 ETRM, indicating it is a supported, runnable concurrent request in both the 12.1.1 and 12.2.2 releases.

Execution Details

The ETRM records the following execution metadata for AUTOREMAPI:

• Product/Module: AR – Receivables
• User-facing name: Automatic Remittances Creation Program (API)
• Execution Method: PL/SQL Stored Procedure
• Argument Method: Standard
• Executable: AUTOREMAPI
• Execution Filename: AR_AUTOREM_API.get_parameters
• Subroutine Name: (not specified in the documented metadata)

Because the execution method is PL/SQL Stored Procedure, the program is invoked directly by the concurrent manager against the Receivables schema rather than through a hosted executable or a Java/Reports engine. The Standard argument method means the concurrent manager derives the run-time parameters from the get_parameters procedure packaged inside AR_AUTOREM_API, and the submission form is generated from the resulting parameter list. The heavy lifting is performed by the underlying automatic remittance API, which validates each candidate receipt, groups eligible transactions into a remittance batch, calculates the remittance total, and creates the remittance record with the appropriate status.

How to Run

The program is submitted through the standard Oracle EBS Submit Request (SRS) window (Requests → Run, or the Receivables responsibility’s concurrent program submission path). Users select Automatic Remittances Creation Program (API) from the list of available Receivables reports and programs. Because the argument method is Standard, the parameter prompts displayed on the SRS window are determined at run time by AR_AUTOREM_API.get_parameters.

Typical parameter values for this program include:

• Remittance date / deposit date — the accounting or deposit date to assign to the created remittances.
• Bank account and receipt method — to scope the receipts and payment instruments included in the batch.
• Selection criteria — such as receipt class, currency, or a range of receipts, so that only the intended population of receipts is picked up.

Best practice is to run the program with a narrow date range and receipt method first to confirm the population, then expand the criteria once the results are validated. Remittances created by the program should be reviewed in the Receivables remittance workbench before the corresponding bank deposit and reconciliation processes are run. Because this is an API-driven program, it is commonly scheduled to run after the receipt interface or lockbox processes that populate the receipts being remitted.

Related Objects

The following objects are commonly associated with AUTOREMAPI in an Oracle Receivables implementation:

• AR_AUTOREM_API — the package containing the automatic remittance creation logic and the get_parameters procedure that drives the concurrent program’s parameter list.
• Automatic Remittances Creation Program — the non-API concurrent program variant used for form-based/standard automatic remittance creation; contrast its behavior with the API version when troubleshooting.
• Remittance batch and remittance tables — the AR remittance schema objects that receive the records created by the API.
• Receipt interface and lockbox programs — standard Receivables processes (for example, the Lockbox Executions and Receipt Interface programs) whose output typically precedes this program.
• Receivables remittance reports — reconciliation and review reports used to inspect the remittances produced.

Consult the Oracle Receivables User Guide and the AR_AUTOREM_API package specification for the authoritative parameter list and return values, as the ETRM metadata for this program documents its execution attributes but does not enumerate the individual API parameters.