Skip Headers

Oracle Financial Services Accounting Hub Implementation Guide
Release 12.1
Part Number E13420-04
Go to Table of Contents
Contents
Go to previous page
Previous
Go to next page
Next

Manual Subledger Journal Entries API

Manual Subledger Journal Entries API Overview

The manual subledger journal entries APIs enable implementers to create, update, delete, complete, and reverse manual subledger journal entries. This API creates one subledger journal entry header or line at a time; therefore, it is not intended to create subledger journal entries in bulk.

See: Subledger Journal Entry Definition Overview, Oracle Subledger Accounting Implementation Guide

Technical Overview

A manual subledger journal entry is not associated with a transaction or document of a subledger application. When users create a manual subledger journal entry, it is created with the event class and event type Manual that is seeded automatically when the subledger application is registered.

The figure below shows the create and complete manual journey entry process and is described in the following text.

Create and Complete Manual Journey Entry

the picture is described in the document text

The create and complete manual journal entry process includes the following steps:

  1. Create journal entry header by calling CREATE_JOURNAL _ENTRY_HEADER API.

  2. Create journal entry line by calling CREATE_JOURNAL_ENTRY_LINE API.

  3. Optionally, update the journal entry header by calling UPDATE_JOURNAL_ENTRY_HEADER API.

  4. Optionally, update the journal entry line by calling UPDATE_JOURNAL_ENTRY_LINE API.

  5. Optionally, delete the journal entry line by calling DELETE_JOURNAL_ENTRY_LINE API.

  6. Complete the journal entry by calling COMPLETE_JOURNAL_ENTRY API.

  7. Optionally, reverse the journal entry by calling REVERSE_JOURNAL_ENTRY API.

Users can delete the journal entry at anytime by calling DELETE_JOURNAL_ENTRY API if the journal entry is not transferred to General Ledger.

XLA_JOURNAL_ENTRIES_PUB_PKG

This section includes the following topics:

Global Constants

The table below describes the constants that are defined in the package specifications.

Constants Defined in the Package Specifications
Name Description Date Type Value
C_TYPE_MANUAL Journal entry type: Manual VARCHAR2 MANUAL
C_TYPE_UPGRADE Journal entry type: Upgrade VARCHAR2 UPGRADE
C_TYPE_MERGE Journal entry type: Merge VARCHAR2 MERGE
C_COMPLETION_OPTION_SAVE Completion option: Save as Incomplete VARCHAR2 S
C_COMPLETION_OPTION_DRAFT Completion option: Draft VARCHAR2 D
C_COMPLETION_OPTION_FINAL Completion option: Final VARCHAR2 F
C_COMPLATION_OPTION_TRANSFER Completion option: Final and Transfer VARCHAR2 T
C_COMPLETION_OPTION_POST Completion option: Final, Transfer, and Post VARCHAR2 P
C_REVERSAL_CHANGE_SIGN Reversal option: Change Sign VARCHAR2 SIGN
C_REVERSAL_SWITCH_DR_CR Reversal option: Switch DR/CR VARCHAR2 SIDE
C_STATUS_INCOMPLETE Journal entry status: Incomplete VARCHAR2 N
C_STATUS_INVALID Journal entry status: Invalid VARCHAR2 I
C_STATUS_DRAFT Journal entry status: Draft VARCHAR2 D
C_STATUS_FINAL Journal entry status: Final VARCHAR2 F
C_DELETE_NORMAL_MODE Deletion mode: Normal VARCHAR2 N
C_DELETE_FORCE_MODE Deletion mode: Force VARCHAR2 F

Published Journal Entries APIs

The following APIs are available in the XLA_JOURNAL_ENTRIES_PUB_PKG:

CREATE_JOURNAL_ENTRY_HEADER

The CREATE_JOURNAL_ENTRY_HEADER API, as described in the table below, creates a new subledger journal entry header. The following conditions must be valid before the journal entry can be created:

Any error found is imported in the message list which can be retrieved from the message list utility function.

The journal entry is created as Incomplete.

Once the entry is created, the output parameter X_AE_HEADER_ID represents the unique identifier of the entry created. It is used in other APIs to uniquely identify the journal entry.

CREATE_JOURNAL_ENTRY_HEADER Parameters
Parameter Description Date Type Type Required
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier; must be a valid application that is registered with the Financial Services Accounting Hub application INTEGER IN Yes
P_LEDGER_ID Ledger identifier INTEGER IN Yes
P_LEGAL_ENTITY_ID Legal entity identifier INTEGER IN No
P_GL_DATE GL date DATE IN Yes
P_DESCRIPTION Journal entry description VARCHAR2 IN Yes
P_JE_CATEGORY_NAME Journal category name VARCHAR2 IN Yes
P_BALANCE_TYPE_CODE Balance type; must be one of the following values:
A – Actual
B – Budget
E – Encumbrance
VARCHAR2 IN Yes
P_BUDGET_VERSION_ID Budget version identifier; required if BALANCE_TYPE_CODE is B INTEGER IN No
P_ENCUMBRANCE_TYPE_ID Encumbrance type identifier; required if BALANCE_TYPE_CODE is E INTEGER IN No
P_REFERENCE_DATE Journal entry reference date DATE IN No
P_ATTRIBUTE_CATEGORY Attribute category VARCHAR2 IN No
P_ATTRIBUTE1 Attribute column VARCHAR2 IN No
P_ATTRIBUTE2 Attribute column VARCHAR2 IN No
P_ATTRIBUTE3 Attribute column VARCHAR2 IN No
P_ATTRIBUTE4 Attribute column VARCHAR2 IN No
P_ATTRIBUTE5 Attribute column VARCHAR2 IN No
P_ATTRIBUTE6 Attribute column VARCHAR2 IN No
P_ATTRIBUTE7 Attribute column VARCHAR2 IN No
P_ATTRIBUTE8 Attribute column VARCHAR2 IN No
P_ATTRIBUTE9 Attribute column VARCHAR2 IN No
P_ATTRIBUTE10 Attribute column VARCHAR2 IN No
P_ATTRIBUTE11 Attribute column VARCHAR2 IN No
P_ATTRIBUTE12 Attribute column VARCHAR2 IN No
P_ATTRIBUTE13 Attribute column VARCHAR2 IN No
P_ATTRIBUTE14 Attribute column VARCHAR2 IN No
P_ATTRIBUTE15 Attribute column VARCHAR2 IN No
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_AE_HEADER_ID Journal entry header identifier created by the API INTEGER OUT N/A
X_EVENT_ID Event internal identifier INTEGER OUT N/A
X_PERIOD_NAME Period name derived from accounting date VARCHAR2 OUT N/A
X_CREATION_DATE Creation date DATE OUT N/A
X_CREATED_BY Created by identifier INTEGER OUT N/A
X_LAST_UPDATE_DATE Last update date DATE OUT N/A
X_LAST_UPDATED_BY Last updated by identifier INTEGER OUT N/A
X_LAST_UPDATE_LOGIN Last update login identifier INTEGER OUT N/A

UPDATE_JOURNAL_ENTRY_HEADER

The UPDATE_JOURNAL_ENTRY_HEADER API, described in the table below, modifies an existing manual subledger journal entry header. The following conditions must be valid before the journal entry can be updated:

Any error found is reported in the message list, which can be retrieved from the message list utility function.

If the status of the journal entry is draft, the draft balance calculation is undone and the draft journal entries created for reporting currencies is deleted.

Once the journal entry is updated, the status is updated to Complete.

The input parameters P_APPLICATION_ID and P_AE_HEADER_ID uniquely identify the journal entry to be updated. Other than the two parameters, all other input parameters are updated with the new values provided to the API.

UPDATE_JOURNAL_ENTRY_HEADER
Parameter Description Data Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier; must be a valid application that is registered with the Financial Services Accounting Hub application INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_LEGAL_ENTITY_ID Legal entity identifier
Default is No.
INTEGER IN No
P_GL_DATE GL date DATE IN Yes
P_DESCRIPTION Description VARCHAR2 IN Yes
P_JE_CATEGORY_NAME Journal category name VARCHAR2 IN Yes
P_BUDGET_VERSION_ID Balance type; required if it is a budget entry INTEGER IN No
P_ENCUMBRANCE_TYPE_ID Encumbrance type; required if it is an encumbrance entry INTEGER IN No
P_REFERENCE_DATE Reference date DATE IN No
P_ATTRIBUTE_CATEGORY Attribute category VARCHAR2 IN No
P_ATTRIBUTE1 Attribute column VARCHAR2 IN No
P_ATTRIBUTE2 Attribute column VARCHAR2 IN No
P_ATTRIBUTE3 Attribute column VARCHAR2 IN No
P_ATTRIBUTE4 Attribute column VARCHAR2 IN No
P_ATTRIBUTE5 Attribute column VARCHAR2 IN No
P_ATTRIBUTE6 Attribute column VARCHAR2 IN No
P_ATTRIBUTE7 Attribute column VARCHAR2 IN No
P_ATTRIBUTE8 Attribute column VARCHAR2 IN No
P_ATTRIBUTE9 Attribute column VARCHAR2 IN No
P_ATTRIBUTE10 Attribute column VARCHAR2 IN No
P_ATTRIBUTE11 Attribute column VARCHAR2 IN No
P_ATTRIBUTE12 Attribute column VARCHAR2 IN No
P_ATTRIBUTE13 Attribute column VARCHAR2 IN No
P_ATTRIBUTE14 Attribute column VARCHAR2 IN No
P_ATTRIBUTE15 Attribute column VARCHAR2 IN No
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_PERIOD_NAME Period name derived from accounting date VARCHAR2 OUT N/A
X_LAST_UPDATE_DATE Last update date DATE OUT N/A
X_LAST_UPDATED_BY Last updated by identifier INTEGER OUT N/A
X_LAST_UPDATE_LOGIN Last update login identifier INTEGER OUT N/A

DELETE_JOURNAL_ENTRY

The DELETE_JOURNAL_ENTRY API, described in the table below, deletes all information of a subledger journal entry including journal entry header and journal entry line. The subledger journal entry must not have been transferred or posted to General Ledger.

The input parameters P_APPLICATION_ID and P_AE_HEADER_ID uniquely identify the journal entry to be deleted.

When deleting a journal entry of status Final, the P_MODE must be F.

DELETE_JOURNAL_ENTRY
Parameter Description Data Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_MODE Deletion mode; must be one of the following values:
N – Normal mode (default)
F – Force mode; deletes all entries that are not posted
VARCHAR2 IN Yes
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes

CREATE_JOURNAL_ENTRY_LINE

The CREATE_JOURNAL_ENTRY_LINE API, described in the table below, creates a journal entry line for a subledger journal entry. The following conditions must be valid before the journal entry lines can be created for a journal entry:

Any error found is reported in the message list, which can be retrieved from the message list utility function.

The input parameters P_APPLICATION_ID and P_AE_HEADER_ID uniquely identify the journal entry for which the journal entry line is created.

If the status of the journal entry is Draft, the draft balance calculation is undone and the draft journal entry created for reporting currency entries are deleted.

Once the journal entry line is created, the journal entry status is updated to Incomplete.

Once the journal entry line is created, the parameters P_APPLICATION_ID, P_AE_HEADER_ID, and X_AE_LINE_NUM represent the unique identifier of the journal entry line created. It is used in other APIs to uniquely identify the journal entry line.

CREATE_JOURNAL_ENTRY_LINE
Parameter Description Data Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_DISPLAYED_LINE_NUMBER Displayed line number generated by the user INTEGER IN Yes
P_CODE_COMBINATION_ID Accounting code combination identifier INTEGER IN Yes
P_GL_TRANSFER_MODE Must be one of the following values:
D – Details
S Summary
VARCHAR2 IN Yes
P_ACCOUNTING_CLASS_CODE Accounting class code VARCHAR2 IN Yes
P_ENTERED_DR Debit amount in transaction currency. Either X_ENTERED_DR or X_ENTERED_CR must be entered. NUMBER IN No
P_ENTERED_CR Credit amount in transaction currency. Either X_ENTERED_DR or X_ENTERED_CR must be entered. NUMBER IN No
P_CURRENCY_CODE Entered transaction currency. If the entered currency is different from the ledger currency, either accounted credit/debit or currency conversion information must be provided. VARCHAR2 IN No
P_ACCOUNTED_DR Debit amount in ledger currency NUMBER IN No
P_ACCOUNTED_CR Credit amount in ledger currency NUMBER IN No
P_CONVERSION_TYPE Conversion rate type for the foreign currency journal entry line VARCHAR2 IN No
P_CONVERSION_DATE Date currency conversion rate is effective DATE IN No
P_CONVERSION_RATE Conversion rate for foreign currency; required if the conversion type is User NUMBER IN No
P_PARTY_TYPE_CODE Required if the natural account segment value of the Accounting Flexfield is defined as a control account.
It must be one of the following values:
C – Customer
S – Supplier
VARCHAR2 IN No
P_PARTY_ID Third party for the journal entry line; required if PARTY_TYPE_CODE is entered; otherwise, this field is ignored. NUMBER IN No
P_PARTY_SITE_ID Third party site for the journal entry line. This is an optional field, and the value is used only if PARTY_ID is not null. NUMBER IN No
P_DESCRIPTION Journal entry line description VARCHAR2 IN No
P_STATISTICAL_AMOUNT Statistical amount NUMBER IN No
P_JGZZ_RECON_FEF Reconciliation reference to be imported into GL VARCHAR2 IN No
P_ATTRIBUTE_CATEGORY Attribute category VARCHAR2 IN No
P_ATTRIBUTE1 Attribute column VARCHAR2 IN No
P_ATTRIBUTE2 Attribute column VARCHAR2 IN No
P_ATTRIBUTE3 Attribute column VARCHAR2 IN No
P_ATTRIBUTE4 Attribute column VARCHAR2 IN No
P_ATTRIBUTE5 Attribute column VARCHAR2 IN No
P_ATTRIBUTE6 Attribute column VARCHAR2 IN No
P_ATTRIBUTE7 Attribute column VARCHAR2 IN No
P_ATTRIBUTE8 Attribute column VARCHAR2 IN No
P_ATTRIBUTE9 Attribute column VARCHAR2 IN No
P_ATTRIBUTE10 Attribute column VARCHAR2 IN No
P_ATTRIBUTE11 Attribute column VARCHAR2 IN No
P_ATTRIBUTE12 Attribute column VARCHAR2 IN No
P_ATTRIBUTE13 Attribute column VARCHAR2 IN No
P_ATTRIBUTE14 Attribute column VARCHAR2 IN No
P_ATTRIBUTE15 Attribute column VARCHAR2 IN No
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_AE_LINE_NUM Line number identifier INTEGER OUT N/A
X_CREATION_DATE Creation date DATE OUT N/A
X_CREATED_BY Created by identifier INTEGER OUT N/A
X_LAST_UPDATE_DATE Last update date DATE OUT N/A
X_LAST_UPDATED_BY Last updated by identifier INTEGER OUT N/A
X_LAST_UPDATE_LOGIN Last update login identifier INTEGER OUT N/A

UPDATE_JOURNAL_ENTRY_LINE

The UPDATE_JOURNAL_ENTRY_LINE API, described in the table below, updates an existing journal entry line. The following conditions must be valid before the journal entry line can be created for the journal entry:

Any error found is reported in the message list, which can be retrieved from the message list utility function.

The input parameters P_APPLICATION_ID, P_AE_HEADER_ID, and P_AE_LINE_NUM uniquely identify the journal entry line to be updated. Other than these three parameters, all other input parameters are updated with the new values provided by the API.

If the status of the journal entry is Draft, the draft balance calculation is undone and the draft journal entry created for reporting currency entries are deleted.

UPDATE_JOURNAL_ENTRY_LINE
Parameter Description Date Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_AE_LINE_NUM Journal entry line number INTEGER IN Yes
P_DISPLAYED_LINE_NUMBER Displayed line number used by the user INTEGER IN Yes
P_CODE_COMBINATION_ID Accounting code combination identifier INTEGER IN Yes
P_GL_TRANSFER_MODE Must be one of the following values:
D – Details
S Summary
VARCHAR2 IN Yes
P_ACCOUNTING_CLASS_CODE Accounting class code VARCHAR2 IN Yes
P_ENTERED_DR Debit amount in transaction currency. Either X_ENTERED_DR or X_ENTERED_CR must be entered. NUMBER IN No
P_ENTERED_CR Credit amount in transaction currency. Either X_ENTERED_DR or X_ENTERED_CR must be entered. NUMBER IN No
P_CURRENCY_CODE Entered currency of the transaction. If the entered currency is different from the ledger currency, either accounted credit/debit or currency conversion information must be provided. VARCHAR2 IN No
P_ACCOUNTED_DR Debit amount in ledger currency NUMBER IN/OUT  
P_ACCOUNTED_CR Credit amount in ledger currency NUMBER IN/OUT  
P_CONVERSION_TYPE Exchange rate type for foreign currency journal entry line VARCHAR2 IN No
P_CONVERSION_DATE Date currency conversion rate is effective DATE IN No
P_CONVERSION_RATE Exchange rate for foreign currency; required if the conversion type is User NUMBER IN No
P_PARTY_TYPE_CODE Required if the natural account segment value of the Accounting Flexfield is defined as a control account.
It must be one of the following values:
C – Customer
S – Supplier
VARCHAR2 IN No
P_PARTY_ID Third party for the journal entry line; required if PARTY_TYPE_CODE is entered. Otherwise, this field is ignored. NUMBER IN No
P_PARTY_SITE_ID Third party site for the journal entry line. This is an optional field, and the value is used only if PARTY_ID is not null. NUMBER IN No
P_DESCRIPTION Journal entry line description VARCHAR2 IN No
P_STATISTICAL_AMOUNT Statistical amount NUMBER IN No
P_JGZZ_RECON_FEF Reconciliation reference to be imported into GL VARCHAR2 IN No
P_ATTRIBUTE_CATEGORY Attribute category VARCHAR2 IN No
P_ATTRIBUTE1 Attribute column VARCHAR2 IN No
P_ATTRIBUTE2 Attribute column VARCHAR2 IN No
P_ATTRIBUTE3 Attribute column VARCHAR2 IN No
P_ATTRIBUTE4 Attribute column VARCHAR2 IN No
P_ATTRIBUTE5 Attribute column VARCHAR2 IN No
P_ATTRIBUTE6 Attribute column VARCHAR2 IN No
P_ATTRIBUTE7 Attribute column VARCHAR2 IN No
P_ATTRIBUTE8 Attribute column VARCHAR2 IN No
P_ATTRIBUTE9 Attribute column VARCHAR2 IN No
P_ATTRIBUTE10 Attribute column VARCHAR2 IN No
P_ATTRIBUTE11 Attribute column VARCHAR2 IN No
P_ATTRIBUTE12 Attribute column VARCHAR2 IN No
P_ATTRIBUTE13 Attribute column VARCHAR2 IN No
P_ATTRIBUTE14 Attribute column VARCHAR2 IN No
P_ATTRIBUTE15 Attribute column VARCHAR2 IN No
P_MSG_MODE The mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_LAST_UPDATE_DATE Last update date DATE OUT N/A
X_LAST_UPDATED_BY Last updated by identifier INTEGER OUT N/A
X_LAST_UPDATE_LOGIN Last update login identifier INTEGER OUT N/A
X_RETCODE Returns the status of the function, which is one of the following:
0 – completed successfully
1 – validation error found
INTEGER OUT N/A

DELETE_JOURNAL_ENTRY_LINE

The DELETE_JOURNAL_ENTRY_LINE API, described in the table below, deletes a subledger journal entry line. The following conditions must be valid before the journal entry line can be deleted for the journal entry:

Any error found is reported in the message list, which can be retrieved from the message list utility function.

The input parameters P_APPLICATION_ID, P_AE_HEADER_ID, and P_AE_LINE_NUM uniquely identify the journal entry line to be deleted.

Once the journal entry line is deleted, the journal entry status is updated to Incomplete.

DELETE_JOURNAL_ENTRY_LINE
Parameter Description Date Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier for which the journal entry line is deleted INTEGER IN Yes
P_AE_LINE_NUM Journal entry line number for which the journal entry line is deleted INTEGER IN Yes
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is raised immediately.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes

COMPLETE_JOURNAL_ENTRY

The COMPLETE_JOURNAL_ENTRY API, described in the table below, completes a subledger journal entry. The following conditions must be valid before the journal entry can be completed:

Any error found is reported in the message list, which can be retrieved from the message list utility function.

The input parameters P_APPLICATION_ID and P_AE_HEADER_ID uniquely identify the journal entry line to be deleted.

When completing the journal entry, validations are performed to ensure the journal entry is valid. If any validation error is found, the X_COMPLETION_STATUS returns X and the validation error can be found in the XLA_ACCOUNTING_ERRORS table.

COMPLETE_JOURNAL_ENTRY
Parameter Description Date Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_COMPLETION_OPTION The action to be performed to the journal entry; available options are as follows:
D – complete draft accounting
F – complete final accounting
T – complete and transfer final accounting
P – complete, transfer, and post final accounting
VARCHAR2 IN Yes
P_MSG_MODE The mode of raising exception; must be one of the following:
S – standard mode: The exception is added to the message list and can be retrieved using the message list utility function.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_AE_STATUS_CODE Result journal entry status code VARCHAR2 OUT N/A
X_FUNDS_STATUS_CODE Funds status code VARCHAR2 OUT N/A
X_COMPLETION_SEQ_VALUE Completion sequence value VARCHAR2 OUT N/A
X_COMPLETION_SEQ_VER_ID Completion sequence version id INTEGER OUT N/A
X_COMPLETED_DATE Completion date DATE OUT N/A
X_GL_TRNSFER_STATUS_CODE GL transfer status code VARCHAR2 OUT N/A
X_LAST_UPDATE_DATE Last update date DATE OUT N/A
X_LAST_UPDATED_BY Last updated by identifier INTEGER OUT N/A
X_LAST_UPDATE_LOGIN Last update login identifier INTEGER OUT N/A
X_TRANSFER_REQUEST_ID Request identifier of the GL transfer request INTEGER OUT N/A
X_RETCODE Returns the status of the function, which is one of the following:
C – completed successfully
S – completed successfully and funds checker has reserved funds successfully
A – completed successfully and funds checker has reserved funds with an Advisory status
X – validation error is found and the journal entry cannot be completed
F – funds reserve failed
VARCHAR2 OUT N/A

REVERSE_JOURNAL_ENTRY

The REVERSE_JOURNAL_ENTRY API, described in the table below, reverses a subledger journal entry. The following conditions must be valid before the journal entry can be reversed.

Any error found is reported in the message list which can be retrieved from the message list utility function.

The input parameters P_APPLICATION_ID and P_AE_HEADER_ID uniquely identify the journal entry line to be deleted.

When completing the journal entry, validations are performed to ensure the reversal journal entry is valid. If any validation error is found, the X_COMPLETION_STATUS returns X and the validation error can be found in the XLA_ACCOUNTING_ERRORS table.

REVERSE_JOURNAL_ENTRY
Parameter Description Date Type Type Default
P_API_VERSION Standard business object API parameter; used by API to compare the version number of incoming calls to its current version number
The current version of the API is 1.0
NUMBER IN Yes
P_INIT_MSG_LIST Standard business object API parameter; allows the API callers to request that the API does the initialization of the message list on their behalf
This parameter accepts the following values:
FND_API_G_FALSE
FND_API_G_FALSE_TRUE
VARCHAR2 IN Yes
X_RETURN_STATUS Standard business object API parameter; represents the result of all the operations performed by the API and it has one of the following values:
FND_API.G_RET_STS_SUCCESS
FND_API.G_RET_STS_ERROR
FND_API.G_RET_STS_UNEXP_ERROR
VARCHAR2 OUT N/A
X_MSG_COUNT Standard business object API parameter
The APIs can generate none, one, or multiple messages and callers can call the API message list utility functions and procedures to retrieve those messages; holds the number of messages in the API message list.
NUMBER OUT N/A
X_MSG_DATA Standard business object API parameter
If the message count is one, this parameter holds the message in an encoded format.
VARCHAR2 OUT N/A
P_APPLICATION_ID Application identifier INTEGER IN Yes
P_AE_HEADER_ID Journal entry header identifier INTEGER IN Yes
P_REVERSAL_METHOD The reversal method; must be one of the following:
SIGN Change sign
SIDE – Switch DR/CR
VARCHAR2 IN Yes
P_GL_DATE The GL date for the reversal journal entry DATE IN Yes
P_COMPLETION_OPTION The action to be performed for the journal entry; available options are as follows:
Ssave as incomplete
Dcomplete draft accounting
F – complete final accounting
T – complete and transfer final accounting
P – complete, transfer, and post final accounting
VARCHAR2 IN Yes
P_MSG_MODE Mode of raising exception; must be one of the following:
S – standard mode: The exception is raised immediately.
O – OAF mode: The exception is added to the OA exception list and raised by calling raiseError() from the client side.
VARCHAR2 IN Yes
X_REV_HEADER_ID Journal entry identifier created for the reversal entry INTEGER OUT N/A
X_REV_EVENT_ID Event identifier created for the reversal entry INTEGER OUT N/A
X_COMPLETION_RETCODE Returns the completion status of the function, which is one of the following:
C completed successfully
S completed successfully and funds checker has reversed funds successfully
A completed successfully and funds checker has reversed funds with an Advisory status
X validation error is found and the journal entry cannot be completed
F – funds reserve failed
VARCHAR2 OUT N/A
P_TRANSFER_REQUEST_ID Request identifier of the GL transfer request INTEGER OUT N/A