Purchase Order Service Version 2

Service to operate on a document, providing specifications and quantities, used to request a supplier to supply a product or service in return for payment. For example, purchase order 1357 with supplier Dell for 10 computers.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderServiceV2/}PurchaseOrderService

Service WSDL URL: https://(FADomain,FSCMServices)/fscmService/PurchaseOrderServiceV2?WSDL

Relationships

The following table describes how this business object service is related to service data objects or other business object services.

Relationship Type Object or Service

Handles

Draft Purchase Order Header Service Data Object Version 2

Handles

Purchase Order Schedule Flexfield

Handles

Draft Purchase Order Line Service Data Object Version 2

Handles

Purchase Order Header Flexfield

Handles

Draft Purchase Order Schedule Service Data Object Version 2

Handles

Purchase Order Schedule Acknowledgment Request

Handles

Purchase Order Schedule Acknowledgment Confirmation Service Data Object Version 1

Handles

Purchase Order Cancellation Request Schedule Service Data Object Version 2

Handles

Purchase Order Cancellation Request Line Service Data Object Version 2

Handles

Purchase Order Distribution Projects Flexfield Service Data Object Version 1

Handles

Draft Purchase Order Schedule Flexfield

Handles

Purchase Order Line Flexfield

Handles

Purchase Order Header Acknowledgment Request

Handles

Draft Purchase Order Line Flexfield

Handles

Draft Purchase Order Distribution Service Data Object Version 2

Handles

Draft Purchase Order Header Flexfield

Handles

Purchase Order Cancellation Request Service Data Object Version 2

Handles

Purchase Order Configuration Line Service Data Object Version 1

Handles

Draft Purchase Order Configuration Line Service Data Object Version 1

Handles

Purchase Order Header Service Data Object Version 2

Handles

Purchase Order Distribution Flexfield

Handles

Purchase Order Distribution Service Data Object Version 2

Handles

Draft Purchase Order Distribution Flexfield

Handles

Purchase Order Line Service Data Object Version 2

Handles

Purchase Order Schedule Service Data Object Version 2

Handles

Draft Purchase Order Distribution Projects Flexfield Service Data Object Version 1

Handles

Purchase Order Acknowledgment Confirmation

Handles

Purchase Order Change Confirmation Service Data Object Version 2

Operations

deleteChangeOrder

An operation to delete a pending change order on a purchase order. This operation is reserved for internal use and is not supported.

Life Cycle Status: Active

Request Payload

Element Name Type Description

poHeaderId

long

The unique identifier of a purchasing document.

initiatingParty

string

The party who originated the purchase document change request.

Response Payload

Element Name Type Description

result

boolean

The output that is returned after acting on the request for which the service was invoked.

cancelChangeOrder

An operation to cancel a pending change order on a purchase order. This operation is reserved for internal use and is not supported.

Life Cycle Status: Active

Request Payload

Element Name Type Description

poHeaderId

long

The unique identifier of a purchasing document.

initiatingParty

string

The party who originated the purchase document change request.

reason

string

The reason for canceling a change order.

Response Payload

Element Name Type Description

result

boolean

The output that is returned after acting on the request for which the service was invoked.

createPurchaseOrder

An operation to create a purchase order.

Life Cycle Status: Active

Request Payload

Element Name Type Description

createOrderEntry

Draft Purchase Order Header Version 2

The input parameter for the createPurchaseOrder operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation Version 2

The output that is returned after acting on the request for which the service was invoked.

changePurchaseOrder

An operation to change a purchase order.

Life Cycle Status: Active

Request Payload

Element Name Type Description

changeOrderEntry

Draft Purchase Order Header Version 2

The input parameter for the changePurchaseOrder operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation Version 2

The output that is returned after acting on the request for which the service was invoked.

cancelPurchaseOrder

An operation to initiate a cancellation request on a purchase order.

Life Cycle Status: Active

Request Payload

Element Name Type Description

cancelOrderParameter

Purchase Order Cancellation Request Version 2

The input parameter for the cancelOrderParameter operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation Version 2

The output that is returned after acting on the request for which the service was invoked.

getPurchaseOrder

An operation to obtain purchase order information, using a purchase order header ID as a search criteria.

Life Cycle Status: Active

Request Payload

Element Name Type Description

poHeaderId

long

The unique identifier of a purchasing document

Response Payload

Element Name Type Description

result

Purchase Order Header Version 2

The output that is returned after acting on the request for which the service was invoked.

acknowledgePurchaseOrder

An operation to acknowledge a purchase order or its change order.

Life Cycle Status: Active

Request Payload

Element Name Type Description

acknowledgeOrderEntry

Purchase Order Header Acknowledgment Request

The input parameter for the acknowledgePurchaseOrder operation.

Response Payload

Element Name Type Description

result

Purchase Order Acknowledgment Confirmation

The output that is returned after acting on the request for which the service was invoked.

findPurchaseOrderByOrderNumber

An operation to obtain purchase order information, using a purchase order number and a sold-to business unit as search criteria.

Life Cycle Status: Active

Request Payload

Element Name Type Description

findCriteria

{http://xmlns.oracle.com/adf/svc/types/}FindCriteria

The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.

OrderNumber

string

The unique identifier of an order in a sold-to business unit.

SoldToLegalEntityId

long

The unique identifier of the legal entity that is liable for the purchase order amount.

SoldToLegalEntity

string

The name of the legal entity that is liable for the purchase order amount.

findControl

{http://xmlns.oracle.com/adf/svc/types/}FindControl

The Find Control is not currently used.

Response Payload

Element Name Type Description

result

Purchase Order Header Version 2

The output that is returned after acting on the request for which the service was invoked.

findPurchaseOrderBySupplierOrderNumber

An operation to obtain purchase order information, using a supplier order number and a supplier site as search criteria.

Life Cycle Status: Active

Request Payload

Element Name Type Description

findCriteria

{http://xmlns.oracle.com/adf/svc/types/}FindCriteria

The criteria used to limit your query result, such as the filter (where clause), the fetch size, and so on.

SoldToLegalEntityId

long

The unique identifier of the legal entity that is liable for the purchase order amount.

SoldToLegalEntity

string

The name of the legal entity that is liable for the purchase order amount.

SupplierOrderNumber

string

The document number that supplier has created in their system, against the order.

findControl

{http://xmlns.oracle.com/adf/svc/types/}FindControl

The Find Control is not currently used.

Response Payload

Element Name Type Description

result

Purchase Order Header Version 2

The output that is returned after acting on the request for which the service was invoked.

getDfltObjAttrHints

An operation to retrieve user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.

Life Cycle Status: Active

Request Payload

Element Name Type Description

viewName

string

The service view usage name, an internal name for the service data object. Specify the value of the <name> element from the getEntityList operation response payload.

localeName

string

The locale to use when evaluating locale-based user interface hints. The localeName is in ISO 639-1 format.

Response Payload

Element Name Type Description

result

{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints

The label and user interface hints for the specified service data object and its attributes, in a name-value pair format.

getServiceLastUpdateTime

An operation that returns the date and time when the schema files referenced in the service definition last changed.

Life Cycle Status: Active

Response Payload

Element Name Type Description

result

{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp

The date and time when the service definition last changed, in ISO 8601 format.

getEntityList

An operation to get the list of service data objects defined on this service.

Life Cycle Status: Active

Response Payload

Element Name Type Description

result

{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo

A list of service data objects defined on this service. For each service data object, the result includes the: QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object.

Security

The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.

Service Operations to Privileges Mapping

Operation Name Privilege Code Privilege Name Privilege Description

acknowledgePurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

cancelChangeOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

cancelPurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

changePurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

createPurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

deleteChangeOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

findPurchaseOrderByOrderNumber

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.

findPurchaseOrderBySupplierOrderNumber

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.

getPurchaseOrder

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.