The Contract Commitment Open API enables users to import contract commitment information from external sources, such as Oracle Core Contract and other non-Oracle systems.
Set API initializes the FND global variables and multiple organizations access control (MOAC). This API validates the ORG_ID and checks whether the user can access the ORG_ID based on the security profile. This API also sets the ORG context. The ORG context specifies the operating unit access, which can be single or multiple.
For information on parameters for Set API, see the Set API Parameters table.
Create API creates a new contract commitment by importing contract commitment data from an external system. Only one contract commitment can be imported at a time. Imported contract commitments must have the following combination of states and statuses to be accepted by contract commitment :
Provisional state
Incomplete approval status
Entered control status
No encumbrance status
Create API imports Standard, Cover, and Release contract commitments, and it also imports partial contract commitment information. However, a release contract commitment can only be imported if its related cover commitment is approved. Internal contract commitment releases cannot be imported using Create API.
The only data imported for a new contract commitment is header information. This includes all fields in the CC header as follows:
Contract Commitment Type
Contract Commitment Number
Contract Reference Number that represents the external contract number
Parent Cover, if it is a Release
State
Control Status
Encumbrance Status
Approval Status
Start Date
Contract Owner
Contract Preparer
Currency Code
Set of Books
Organization Identification
The Create API enables users to query information in contract commitment that is imported from an external system. Because only CC header information is imported, users must query the contract commitment to add account line and detail payment forecast information.
The Create API takes into account Multi-Organization and Multiple Reporting Currencies functionality within Oracle applications.
The Create API provides a link between the external contract number and the contract commitment number in contract commitment.
The Contract Commitment Create API process consists of the following steps:
The Contract Commitment Create API obtains data from the external system through parameters.
For information on parameters for Create API, see the Create API Parameters table.
The data passed from the external system is validated. If there are no errors, the IGC_CC_HEADERS table is populated with the data creating a new contract commitment.
Note: The Create API process takes into consideration only the contract commitment Header information. The contract commitment from the external system is imported as a new contract into contract commitment irrespective of the commitment type. For Release commitment type, its related cover must exist in Contract Commitment with an Approved or Approved Encumbered approval status. Create API cannot import internal contract commitment releases.
If Create API finds errors in the data or validation fails, the following occurs:
The details of the error are written to the message stack.
The import process rolls back the transaction.
The contract is not created in Contract Commitment.
Update API updates standard and release contract commitment types in an external system and updates the Control Status of the associated contract commitment in Contract Commitment. Updating the control status includes the following tasks:
opens a contract commitment for invoice matching
closes a contract commitment for invoice matching
places a contract commitment on hold
releases a contract commitment from hold
When the hold is released on the contract commitment, Update API initiates the contract commitment approval process.
The Cover contract commitment type cannot be opened, closed, or put on hold.
To work with Update API, a contract commitment must meet the following conditions:
The contract commitment must be in a state of Confirmed with an approval status of Approved or Approved Encumbered.
The contract commitment in contract commitment must be linked to a contract reference number in the external system.
Update API updates the Action History with the appropriate action taken.
For information on Update API parameters, see the Update API Parameters table.
Select API retrieves the external reference number associated with a contract commitment in Contract Commitment. If the API returns the external reference number, it can be modified. If an external reference number does not exist, users can enter one.
For information on Select API parameters, see the Select API Parameters table.
Link API links a contract commitment in Contract Commitment with an external contract. This API is used when a contract commitment exists in Contract Commitment and users want to link it to a contract in an external system.
For information on Link API parameters, see the Link API Parameters table.
Related Topics
Contract Commitment Operations API in the Integration Repository (http://www-apps.us.oracle.com:1100/irep/).
| Columns | Type | Comments | Validation |
|---|---|---|---|
| p_api_version_number | required | API version | Makes standard API check. |
| p_responsibility_id | required | Responsibility ID | To validate the ORG_ID and to set the ORG context based on the security profile the responsibility ID and the User ID are required as input values. |
| p_user_id | required | User ID | |
| p_resp_appl_id | required | Application ID | |
| p_operating_unit_id | required | ORG ID |
| Columns | Type | Comments | Validation |
|---|---|---|---|
| ORG_ID | required | CC_HEADER_ID is derived by the Open API. | |
| CC_TYPE | required | S for Standard; C for Cover; R for Release | The valid CC Types are Standard, Cover, and Release. |
| CC_REF_NUM | required | reference number from the external system; must be unique across Organization and Set of Books combination | no validation |
| CC_NUM | required | user-provided unique contract number; can be contract number currently used in the external system | Validate that CC_NUM is unique in the table. Commitment Number is unique across Organization. Validate that a cover contract commitment already exists in Contract Commitment if the commitment type is Release. |
| PARENT_HEADER_ID | required for Release contract type only | user-derived number; provides link of Cover to Releases | If CC Type is Release, then the Interface Parent Header ID cannot be NULL. If CC Type is Cover or Standard, then the Interface Parent Header ID must be NULL. |
| VENDOR_ID | optional | Validate the Vendor ID against the PO_VENDORS table to ensure that the Vendor ID exists in the table. Validate that Vendor ID is active and that the PURCHASING_SITE_FLAG is Y for Yes. |
|
| VENDOR_SITE_ID | optional | Validate the Vendor Site ID against the PO-VENDOR-SITES table to ensure that the Vendor Site ID exists in the table. Validate that Vendor Site ID is active and that the PURCHASING_SITE_FLAG is Y for Yes. If Vendor ID is NULL, then this field must also be NULL. |
|
| VENDOR_CONTACT_ID | optional | no validation | |
| TERM_ID | optional | AP_TERMS_VAL_V.NAME must be used for validation. Terms are validated against the A_TERMS_VAL_V view. The list of values should contain the name, description, and term identification. The term name corresponds to the column AP_TERMS_VAL_V.NAME.Active Payment Terms. |
|
| LOCATION_ID | optional | Validate Location ID against the HR_LOCATIONS table to ensure that the Location ID exists in the table. Validate that Location ID is active and that the BILL_TO_SITE_FLAG is Y for Yes. If Vendor ID is NULL, then this field must also be NULL. |
|
| SET_OF_BOOKS_ID | required | The SET_OF_BOOKS_ID must be the set of books identifier of the person logged in. The SET_OF_BOOKS_ID and the ORG_ID must be checked as a valid combination. Validate that the SET_OF_BOOKS_ID is a valid identification value within the installed application. |
|
| CC_DESC | optional | no validation | |
| CC_START_DATE | required | Start Date must be less than or equal to the End Date. If commitment type is Release, then the entered Start Date must be within the start and end date for the corresponding contract commitment. If commitment type is Cover, then the Start Date must be less than or equal to the minimum start date of all its releases. |
|
| CC_END_DATE | optional | If commitment type is Release, then the entered End Date must be within the start and end date for the corresponding contract commitment. If commitment type is Cover, then the End Date must be greater than or equal to the maximum end date for all its releases. |
|
| CC_OWNER_USER_ID | required | Employee Identification corresponding to the owner or employee name must be stored in IGC_CC_HEADERS.CC_OWNER_USER_ID column. mandatory active employee |
|
| CC_PREPARER_USER_ID | required | The User Identification corresponding to the user name must be stored in the IGC_CC_HEADERS.CC_PREPARER_USER_ID column. Default value corresponds to FND_PROFILE.USER_ID. Preparer User Identification must also be copied to the IGC_CC_HEADERS_V.CC_CURRENT_USER_ID column. mandatory |
|
| CURRENCY_CODE | required | Validate that the currency code is the functional currency for the Set of Books ID. | |
| CONVERSION_TYPE | optionally required | required if currency nonfunctional | NULL; no validation |
| CONVERSION_DATE | optionally required | required if currency nonfunctional | NULL; no validation |
| CONVERSION_RATE | optionally required | required if currency nonfunctional | NULL; no validation |
| LAST_UPDATE_DATE | required | System date | |
| LAST_UPDATED_BY | required | no validation | |
| LAST_UPDATED_LOGIN | required | no validation | |
| CREATED_BY | required | no validation | |
| CREATION_DATE | required | no validation | |
| CC_CURRENT_USER_ID | required | same as CC_PREPARER_USER_ID | The User Identification corresponding to the user name must be stored in the IGC_CC_HEADERS.CC_PREPARER_USER_ID column. Default value corresponds to FND_PROFILE.USER_ID. Preparer User Identification must also be copied to the IGC_CC_HEADERS_V.CC_CURRENT_USER_ID column. mandatory |
| WF_ITEM_TYPE | optional | no validation | |
| WF_ITEM_KEY | optional | no validation | |
| CONTEXT | optional | no validation | |
| ATTRIBUTE1 | optional | no validation | |
| ATTRIBUTE2 | optional | no validation | |
| ATTRIBUTE3 | optional | no validation | |
| ATTRIBUTE4 | optional | no validation | |
| ATTRIBUTE5 | optional | no validation | |
| ATTRIBUTE6 | optional | no validation | |
| ATTRIBUTE7 | optional | no validation | |
| ATTRIBUTE8 | optional | no validation | |
| ATTRIBUTE9 | optional | no validation | |
| ATTRIBUTE10 | optional | no validation | |
| ATTRIBUTE11 | optional | no validation | |
| ATTRIBUTE12 | optional | no validation | |
| ATTRIBUTE13 | optional | no validation | |
| ATTRIBUTE14 | optional | no validation | |
| ATTRIBUTE15 | optional | no validation |
| Columns | Type | Comments |
|---|---|---|
| CC_NUM | required | contract commitment number created through Create API |
| SET_OF_BOOKS_ID | required | |
| ORG_ID | required | |
| CONTROL_STATUS_CODE | required | OP indicates Open; CL indicates Close; OH indicates On Hold; RH indicates Release Hold. |
| LAST_LOGIN_ID | required | |
| LAST_UPDATED_BY | required |
| Columns | Type | Comments |
|---|---|---|
| SET_OF_BOOKS_ID | required | contract commitment number created through Create API |
| ORG_ID | required | |
| CC_NUM | required |
| Columns | Type | Comments |
|---|---|---|
| CC_REF_NUM | required | reference number from external system |
| ORG_ID | required | |
| SET_OF_BOOKS_ID | required | |
| CC_HEADER_ID | required | header identifier for contract commitment number in Contract Commitment |
| CC_NUM | required | contract commitment number in Contract Commitment |