4

OPM Inventory Transfer API

This topic describes the OPM Inventory Transfer API and the parameters needed for the API, as well as the associated details.

OPM Inventory Transfer API (Patch 2466753)

The OPM Inventory Transfer API lets you track and control intransit movement of material. The API lets you perform the following transfer funtionality:
n

Create Release Receive Purge Cancel

The public call interface is:

PROCEDURE INVENTORY_TRANSFER
( , , , , , , , , p_api_version p_init_msg_list p_commit p_validation_level p_transfer_rec x_return_status x_msg_count x_msg_data x_transfer_rec IN IN IN IN IN OUT OUT OUT OUT NUMBER VARCHAR2 DEFAULT FND_API.G_FALSE VARCHAR2 DEFAULT FND_API.G_FALSE VARCHAR2 DEFAULT FND_API.G_VALID_LEVEL_FULL GMIGXFR.TYPE_XFER_REC NOCOPY VARCHAR2 NOCOPY NUMBER NOCOPY VARCHAR2 NOCOPY IC_XFER_MST%ROWTYPE)

OPM Inventory Transfer API

4-1

OPM Inventory Transfer API (Patch 2466753)

P_transfer_rec is defined as follows.

Parameter Transfer Action

Type Number

Length Variable

Default NULL

Required Yes

Description Indicates the type of transaction. The valid values are:

n n n n n

Validation If you do not specify the Transfer Action value, then the error Invalid number displays. If the specified number is not within 1 through 5, then the error Invalid Transfer Action Code displays. If an existing Transfer Number is specified as one of the parameters for an Insert Transfer Action, then the error Transfer Number Exists displays. For all other actions, if a valid transfer number is not specified, then the error Invalid Transfer Number displays. None

1 - Insert 2 - Release 3 - Receive 4 - Purge 5 - Cancel

Transfer Number

Varchar2

32

NULL

Required for the transfer action other than 1

Unique number identifying the transfer.

Transfer Batch Organizati on Code Item Number

Varchar2

50

NULL

Ne

Indicates the batch number being transferred. Organization which created the transfer. Indicates the unique item number.

Varchar2

NULL

Yes

Must be a valid organization code for all the transfer actions. Must be a valid item. Validated only for the Insert Transfer Action.

Varchar2

32

NULL

Yes

4-2 Oracle Process Manufacturing Inventory API Users Guide

OPM Inventory Transfer API (Patch 2466753)

Parameter Lot Number

Type Varchar2

Length 32

Default NULL

Required Yes

Description Lot number associated with the item being transferred if the item is lot-controlled.

Validation Must be a valid lot associated to the item. Validated only for the Insert Transfer Action. For Release and Receive Transfer Actions, the system checks whether the lot status was changed after the transfer creation. Must be a valid sublot associated with the item and lot combination. Must be an existing warehouse. Validated only for the Insert Transfer Action. For Release and Cancel Transfer Actions, the system checks whether the user has access to the source warehouse. Must be an existing location from the specified warehouse. If the GMI: Show Lots With No On hand Inventory profile is set to No, then the location must have onhand inventory for the given item and lot combination. Validated only for the Insert Transfer Action.

Sublot Number

Varchar2

32

NULL

Yes, if the item is sublotcontrolled Yes

Sublot number associated with the lot being transferred if the item is sublot-controlled. Warehouse from where the materials are being transferred.

Source Warehouse

Varchar2

NULL

Source Location

Varchar2

16

NULL

Yes, if the source warehouse is locationcontrolled

Location from where the materials are being transferred.

OPM Inventory Transfer API

4-3

OPM Inventory Transfer API (Patch 2466753)

Parameter Target Warehouse

Type Varchar2

Length 16

Default NULL

Required Yes

Description Warehouse to where materials are being transferred.

Validation Must be an existing warehouse and different from the source warehouse. Validated only for the Insert Transfer Action. For the Receive Transfer Action, the system checks whether the user has access to the target warehouse. Must be an existing warehouse and should be same from the source warehouse. Must be less than the Scheduled Receive Date. If this value is null, then the system date is used. Validated only for the Insert Transfer Action. Must be greater than the Scheduled Release Date. If this value is null, then the system date is used. Validated only for the Insert Transfer Action. Must not be a future date and less than the Actual Receive Date. If this value is null during release, then the system date is assigned. Validated only for Insert and Release Transfer Actions.

Target Location

Varchar2

NULL

Yes, if the source warehouse is location controlled No

Location to where materials are being transferred.

Scheduled Release Date

Date

SYSDATE

Indicates the date when the material is scheduled to release.

Scheduled Receive Date

Date

SYSDATE

No

Indicates the date when the material is scheduled to be received.

Actual Release Date

Date

SYSDATE

No

Indicates the date when the material was actually released.

4-4 Oracle Process Manufacturing Inventory API Users Guide

OPM Inventory Transfer API (Patch 2466753)

Parameter Actual Receive Date

Type Date

Length 8

Default SYSDATE

Required No

Description Indicates the date when the material was actually received.

Validation Must not be a future date and greater than the Actual Release Date. If this value is null during receive, then the system date is assigned. Validated only for Insert and Receive Transfer Actions. Must be greater than the system date and in an open period. If this value is null during cancel, then the system date is assigned. Validated only for the Cancel Transfer Action. Must not be null for the nondual and nondefault items. The specified quantity must be positive. Validated for Insert and Release Transfer Actions against the current onhand quantity. Must not be null for the nondual and nondefault items. The specified quantity must be positive.

Cancel Date

Date

SYSDATE

No

Indicates the cancel date.

Release Primary Quantity

Number

Variable

NULL

Yes, for the nondual and nondefault items

Quantity being transferred in the primary unit of measure.

Release Secondary Quantity

Number

Variable

NULL

Yes, if the release primary quantity is not passed for the dual and fixed items No

Quantity being transferred in the secondary unit of measure.

Reason Code

Varchar2

NULL

Reason code associated with the transfer.

Must be an existing reason code. If the GMA: Reason Code Security profile is set to Yes, then the reason codes set up for the specific responsibility are selected. Validated for all transfer actions.

OPM Inventory Transfer API

4-5

OPM Inventory Transfer API (Patch 2466753)

Parameter Comments

Type Varchar2

Length 2000 240

Default NULL NULL

Required No No

Description Comments Descriptive flexfield segment from 1 through 30. Descriptive flexfield segment.

Validation None None

Attribute1 Varchar2 to Attribute30 Attribute Category User name Varchar2 Varchar2

240 100

NULL OPM

No Yes

None

Name of the user Must be a valid user running the transfer. name that exists in the fnd_user table. Validated for all transfer actions.

4-6 Oracle Process Manufacturing Inventory API Users Guide