8Business Object Services

Purchase Agreement

Service to operate on a document that is an agreement between a supplier and the requesting organization. It is used to document long-term agreements and can be referenced by purchase orders in the future. For example, agreement 1234 with supplier Dell for 50 computers.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseAgreementService/}PurchaseAgreementService

Service WSDL URL: https://servername/fscmService/PurchaseAgreementService?WSDL

Relationships

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

Operations

deleteChangeOrder

An operation to delete a pending change order on an agreement. 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

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

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 an agreement. 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.

cancelPurchaseAgreement

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

Life Cycle Status: Active

Request Payload

Element Name Type Description

cancelAgreementParameter

Purchase Agreement Cancellation Request

The input parameter for the cancelAgreementParameter operation.

Response Payload

Element Name Type Description

result

Purchase Agreement Cancel Confirmation

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

Request Payload

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

Request Payload

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

All Operations

PO_MANAGE_PURCHASE_AGREEMENT_WEB_SERVICE_PRIV

Manage Purchase Agreement by Web Service

Allows management of purchase agreements using web service.

Purchase Agreement Cancel Confirmation

An object, representing a set of parameters, that is returned after successful completion of a cancel operation on a purchase agreement.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseAgreementService/}RequestResults

Relationships

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

Relationship Type Object or Service

Handled by

Purchase Agreement

Attributes

The following table describes attributes in the service data object.

Name Type Description

AgreementNumber

string

The display number of an agreement in a procurement business unit.

ChangeOrderNumber

string

The unique identifier of a change order for a document.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

ProcurementBUId

long

The business unit that manages and owns the purchasing document.

RequestStatus

string

The result of the request for which the service was invoked.

Purchase Agreement Cancellation Request

An object, representing a set of attributes, used to initiate a cancellation request on a purchase agreement.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseAgreementService/}CancelAgreementHeader

Relationships

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

Relationship Type Object or Service

Contains

Purchase Agreement Cancellation Request Line

Handled by

Purchase Agreement

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeWithinDays

decimal

The number of days within which the supplier is requested to acknowledge the document.

AgreementNumber

string

The display number of an agreement in a procurement business unit.

CancelAgreementLine

Purchase Agreement Cancellation Request Line

The criteria for canceling a blanket purchase agreement line.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CanceledByRole

string

The role or party initiating a document cancellation request. It can be a buyer or a supplier.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

ProcurementBUId

long

The business unit that manages and owns the purchasing document.

ProcurementBusinessUnit

string

The business unit that manages and owns the purchasing document.

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

Purchase Agreement Cancellation Request Line

An object, representing a set of attributes, used to initiate a cancellation request on a purchase agreement line.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseAgreementService/}CancelAgreementLine

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Agreement Cancellation Request

Handled by

Purchase Agreement

Attributes

The following table describes attributes in the service data object.

Name Type Description

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

LineNumber

decimal

The unique identifier of a line on a document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Purchase Order (Deprecated)

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: Deprecated

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

Service WSDL URL: https://servername/fscmService/PurchaseOrderService?WSDL

Relationships

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

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

The input parameter for the createPurchaseOrder operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation

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

The input parameter for the changePurchaseOrder operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation

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

The input parameter for the cancelOrderParameter operation.

Response Payload

Element Name Type Description

result

Purchase Order Change Confirmation

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

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.

SoldToBUId

long

The unique identifier of the business unit 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

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.

SoldToBUId

long

The unique identifier of the business unit that is liable for the purchase order amount.

SupplierOrderNumber

string

The document number the 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

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

Request Payload

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

Request Payload

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

getPurchaseOrder

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the 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.

findPurchaseOrderBySupplierOrderNumber

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.

cancelChangeOrder

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.

cancelPurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

Draft Purchase Order Distribution

An object, representing a set of distribution attributes, that is used to provide values while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderEntryDistribution

Relationships

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

Relationship Type Object or Service

Contains

Draft Purchase Order Distribution Flexfield

Contained by

Draft Purchase Order Schedule

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

ChangeReason

string

A text description capturing the reason for changing the entity.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

DeliverToLocationCode

string

A code indicating the final delivery location for goods previously received from a supplier.

DeliverToLocationId

long

The unique identifier of a final delivery location for goods previously received from a supplier.

DestinationChargeAccount

string

The account to charge for the cost of this item in the requisitioning business unit.

DestinationChargeAccountId

long

The unique identifier of the account to charge for the cost of this item in the requisitioning business unit.

DestinationSubinventory

string

The display name of a subinventory to which the requested item should be delivered.

DistributionFlexfield

Draft Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and capture values for these additional attributes, while creating or changing a purchase order distribution.

DistributionNumber

decimal

Unique identifier of the distribution associated with a schedule. A distribution is an entity on a purchase order where charge accounts and project information are captured.

LineLocationId

long

The unique identifier of a purchase order schedule.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

POChargeAccount

string

The account to be charged for the purchase when the requisitioning and sold-to business units are the same.

POChargeAccountId

long

The unique identifier of the account to be charged for the purchase when the requisitioning and sold-to business units are the same.

PODistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

Quantity

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

The ordered quantity for the purchase order distribution.

RequesterId

long

The unique identifier of the requester.

RequesterName

string

The name of the requester.

Draft Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and capture values for these additional attributes, while creating or changing a purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchaseOrderDistribution/}DraftPODistributionDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Distribution Version 2

Contained by

Draft Purchase Order Distribution

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoDistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Header

An object, representing a set of header attributes, that is used to provide values while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderEntry

Relationships

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

Relationship Type Object or Service

Contains

Draft Purchase Order Header Flexfield

Contains

Draft Purchase Order Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeWithinDays

decimal

The number of days within which the supplier is requested to acknowledge the document.

ApprovalAction

string

The display name indicating whether to submit the document for approval after import, or to import the document as approved or as draft.

ApprovalActionCode

string

A code indicating whether to submit the document for approval after import, or to import the document as approved or as draft.

BillToLocationCode

string

The code of the location to which the supplier should send the invoice.

BillToLocationId

long

The unique identifier of the location to which the supplier should send the invoice.

BuyerEmail

string

The email address of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerId

long

The unique identifier of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerName

string

The display name of a buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ChangeOrderDescription

string

A text description capturing the reason or purpose of the change order.

ChangeOrderInitiatingParty

string

The code indicating the party who originated the purchase document change request. Valid values are requester, buyer, supplier and catalog administrator.

ConfirmingOrderFlag

boolean

Indicates whether the document is a confirmation of an order the supplier may already be aware of.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

ConversionRateType

string

The display name indicating the type of conversion rate, such as user defined, spot, or corporate.

ConversionRateTypeCode

string

A code indicating the type of currency conversion rate, such as user defined, spot, or corporate.

Currency

string

The display name of the three-letter ISO code associated with a currency.

CurrencyCode

string

A code indicating the three-letter ISO code associated with a currency.

DefaultShipToLocationCode

string

The code of the ship-to location that is defaulted automatically while creating an order.

DefaultShipToLocationId

long

The unique identifier of the ship-to location that is defaulted automatically while creating an order.

DocumentDescription

string

Text describing an order or an agreement.

DocumentFiscalClassification

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentFiscalClassificationCode

string

Code for a classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentStyle

string

The name of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentStyleId

long

The unique identifier of the document style, enabled for the purchasing document type, as displayed to the user.

FOB

string

The point or location where the ownership title of goods is transferred from the seller to the buyer.

FOBCode

string

The code of the point or location where the ownership title of goods is transferred from the seller to the buyer.

FreightTerms

string

A commercial term that indicates who pays the charge for transporting the goods by common carrier.

FreightTermsCode

string

A code for a commercial term that indicates who pays the charge for transporting the goods by common carrier.

HeaderFlexfield

Draft Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes and capture values for these additional attributes while creating or changing a purchase order.

InterfaceSourceCode

string

A code that indicates the outside source that the data was imported from.

NoteToReceiver

string

Special text instructions to the receiver in the docking area, to be reviewed while performing the receipt.

NoteToSupplier

string

Special text instructions to the supplier, to be reviewed while completing your order.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

PayOnReceiptFlag

boolean

Indicates whether the supplier should be paid as soon as the receipt is performed. This can happen only if enabled on the supplier.

PaymentTerms

string

Term used to schedule payments, and to calculate due dates, discount dates, and discount amounts for each invoice.

PaymentTermsId

long

The unique identifier of the term used to schedule payments, and to calculate due dates, discount dates, and discount amounts for each invoice.

ProcurementBUId

long

The business unit that manages and owns the purchasing document.

ProcurementBusinessUnit

string

The business unit that manages and owns the purchasing document.

PurchaseOrderEntryLine

Draft Purchase Order Line

The purchase order line information.

ReferenceNumber

string

The display number used to identify an imported purchase order from a legacy system.

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequisitioningBUId

long

The unique identifier of the business unit of the requisition.

RequisitioningBusinessUnit

string

Business unit of the requisition.

SoldToBUId

long

The unique identifier of the business unit that is liable for the purchase order amount.

SoldToBusinessUnit

string

The name of the business unit that is liable for the purchase order amount.

Supplier

string

Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierCommunicationEmail

string

The email address specified on the document to which the document after approval will be communicated.

SupplierCommunicationFax

string

The fax number specified on the document to which the document after approval will be communicated.

SupplierCommunicationMethod

string

Indicates how the document should be communicated to the supplier such as email, fax, or EDI.

SupplierCommunicationMethodCode

string

A code indicating how the document should be communicated to the supplier such as email, fax, or EDI.

SupplierContactEmail

string

The email address for a supplier employee who represents the supplier in communications with the buying organization.

SupplierContactId

long

The unique identifier of the employee of the supplier identified on purchasing documents, and who represents the supplier in communications with the buying organization.

SupplierContactName

string

Employee of the supplier identified on purchasing documents, and who represents the supplier in communications with the buying organization.

SupplierId

long

The unique identifier of the organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierOrderNumber

string

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

SupplierSiteCode

string

A code indicating an entity that models how the buying organization conducts business with the supplier.

SupplierSiteId

long

The unique identifier of the entity that models how the buying organization conducts business with the supplier.

TaxationCountry

string

The country where the transaction is deemed to have taken place for taxation purposes.

TaxationCountryCode

string

The code of the country where the transaction is deemed to have taken place for taxation purposes.

Draft Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and capture values for these additional attributes, while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentHeader/}DraftPOHeaderDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Header

Contained by

Draft Purchase Order Header Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Line

An object, representing a set of line attributes, that is used to provide values while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderEntryLine

Relationships

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

Relationship Type Object or Service

Contains

Draft Purchase Order Schedule

Contains

Draft Purchase Order Line Flexfield

Contained by

Draft Purchase Order Header

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

CategoryId

long

The unique identifier of the code used to group items with similar characteristics.

CategoryName

string

The display name of a category used to group items with similar characteristics.

ChangeReason

string

A text description capturing the reason for changing the entity.

HazardClass

string

Name to identify and classify hazardous materials, to facilitate safety regulations compliance.

HazardClassId

long

The unique identifier of the classification of hazardous materials used to facilitate safety regulations compliance.

ItemDescription

string

Text that describes the item being purchased.

ItemId

long

The unique identifier of an item.

ItemNumber

string

The display name of an item representing anything you make, purchase, or sell, including components, subassemblies, finished products, or supplies.

ItemRevision

string

Identifier that indicates version of inventory item being referenced on the order line.

LineFlexfield

Draft Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes and capture values for these additional attributes while creating or changing a purchase order line.

LineNumber

decimal

The unique identifier of a line on a document.

LineType

string

A type to indicate whether a purchasing document line is for goods or services, as well as some default attributes associated with the line.

LineTypeId

long

The unique identifier of a type to indicate whether a purchasing document line is for goods or services, as well as to default some attributes associated with the line.

NegotiatedFlag

boolean

Indicates that the price on the document line is a value agreed on in advance during discussions between the buyer and the supplier.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Price

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

Price of the item on the document line.

PurchaseOrderEntrySchedule

Draft Purchase Order Schedule

The purchase order schedule information.

Quantity

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

The ordered quantity for the purchase order line.

SourceAgreementId

long

The unique identifier of the purchase agreement against which this purchase order line is released.

SourceAgreementLine

decimal

The purchase agreement line against which this purchase order line is released.

SourceAgreementNumber

string

The purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBUId

long

The unique identifier of the procurement business unit of the purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBusinessUnit

string

The name of the procurement business unit of the purchase agreement against which this purchase order line is released.

SupplierItem

string

The supplier's identification number or code for the goods ordered on your order line.

UNNumber

string

The United Nations identification number for the hazardous material.

UNNumberId

long

The unique identifier of the United Nations identification number for the hazardous material.

UnitOfMeasure

string

A division of quantity defined as a standard of measurement or exchange.

UnitOfMeasureCode

string

A code indicating a division of quantity defined as a standard of measurement or exchange.

Draft Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes, and capture values for these additional attributes, while creating or changing a purchase order line.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentLine/}DraftPOLineDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Line

Contained by

Draft Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Schedule

An object, representing a set of schedule attributes, that is used to provide values while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderEntrySchedule

Relationships

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

Relationship Type Object or Service

Contains

Draft Purchase Order Distribution

Contains

Draft Purchase Order Schedule Flexfield

Contained by

Draft Purchase Order Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

AccrueAtReceiptFlag

boolean

Indicates whether the purchase order schedule will be accrued at receipt.

AllowSubstituteReceiptsFlag

boolean

Indicates whether the purchase order schedule can receive substitute item in place of an ordered item.

AssessableAmount

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

The price at which a product is valued, by a tax authority, for tax calculation purposes. The same product can have more than one assessable value, as given by different tax authorities.

ChangeReason

string

A text description capturing the reason for changing the entity.

CountryOfOrigin

string

The display name of a country from which goods are exported.

CountryOfOriginCode

string

A code indicating the country from which goods are exported.

DestinationType

string

The display name indicating if the item should be charged to an inventory or should be expensed.

DestinationTypeCode

string

A code indicating if the item should be charged to an inventory or should be expensed.

EarlyReceiptToleranceDays

decimal

Maximum acceptable number of days early for receipts.

IntendedUse

string

A tax classification based on the purpose for which a product is used.

IntendedUseId

long

The unique identifier of the tax classification based on the purpose for which a product is used.

InvoiceCloseTolerancePercent

decimal

The tolerance that allows a purchase order schedule to be automatically closed for invoicing, if it is within the tolerance at billing, when Payables matches invoices to purchase orders or receipts.

InvoiceMatchOption

string

The option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

InvoiceMatchOptionCode

string

The code associated with the option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

LateReceiptToleranceDays

decimal

Maximum acceptable number of days late for receipts.

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

MatchApprovalLevelCode

string

A code that indicates how purchase order, receipt, inspection, and invoice quantities should match before the corresponding invoice can be paid.

NeedByDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the buying company requests the supplier to deliver the item.

NoteToReceiver

string

Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

OverReceiptAction

string

Determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptActionCode

string

A code that determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptTolerancePercent

decimal

The tolerance that allows a purchase order schedule to receive more than the ordered quantity or amount, without triggering the over-receipt action.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

ProductCategory

string

A type of product fiscal classification used to classify products.

ProductCategoryCode

string

A code associated with a type of product fiscal classification used to classify products.

ProductFiscalClassification

string

A classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductFiscalClassificationId

long

The unique identifier of the classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductType

string

The nature or the product involved in a taxable transaction. For example, goods or services.

ProductTypeCode

string

A code indicating the nature or the product involved in a taxable transaction. For example, goods or services.

PromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the item ordered by the buying company.

PurchaseOrderEntryDistribution

Draft Purchase Order Distribution

The purchase order distribution information.

Quantity

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

The ordered quantity for the purchase order schedule.

ReceiptCloseTolerancePercent

decimal

The percentage that allows a purchase order schedule to be automatically closed for receiving, if it is within the tolerance at receiving.

ReceiptDateExceptionAction

string

The display name of an action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptDateExceptionActionCode

string

A code indicating the action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptRouting

string

A method of simplifying transaction entry by specifying routing steps for receipts.

ReceiptRoutingId

long

The unique identifier of a method of simplifying transaction entry by specifying routing steps for receipts.

ScheduleFlexfield

Draft Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes and capture values for these additional attributes while creating or changing a purchase order schedule.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

SecondaryQuantity

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

The quantity converted in the secondary unit of measure of a dual UOM controlled item.

ShipToExceptionAction

string

The display name of how to handle receipts when the receiving location differs from the ship-to location.

ShipToExceptionActionCode

string

A code indicating how to handle receipts when the receiving location differs from the ship-to location.

ShipToLocationCode

string

A code indicating a location where the supplier should ship the goods.

ShipToLocationId

long

The unique identifier of the location where the supplier should ship the goods.

ShipToOrganizationCode

string

A code indicating an inventory organization where the supplier should ship the goods.

ShipToOrganizationId

long

The unique identifier of the inventory organization where the supplier should ship the goods.

SupplierOrderLine

string

The number or text that the supplier uses to identify a purchase order schedule.

TaxClassification

string

The display name of a group of taxes for reporting and processing purposes.

TaxClassificationCode

string

A code indicating a grouping of taxes for reporting and processing purposes.

TransactionBusinessCategory

string

A business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

TransactionBusinessCategoryCode

string

A code indicating a business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

UserDefinedFiscalClassification

string

A classification for any tax requirement that you cannot define using the existing fiscal classification types.

UserDefinedFiscalClassificationCode

string

A classification code for any tax requirement that you cannot define using the existing fiscal classification types.

Draft Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and capture values for these additional attributes, while creating or changing a purchase order schedule.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentSchedule/}DraftPOScheduleDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Schedule Version 2

Contained by

Draft Purchase Order Schedule

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Cancellation Request

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}CancelOrderHeader

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Cancellation Request Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeWithinDays

decimal

The number of days within which the supplier is requested to acknowledge the document.

CancelOrderLine

Purchase Order Cancellation Request Line

The criteria for canceling a purchase order line.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

CanceledByRole

string

The role or party initiating a document cancellation request. It can be a buyer or a supplier.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

SoldToBUId

long

The unique identifier of the business unit that is liable for the purchase order amount.

SoldToBusinessUnit

string

The name of the business unit that is liable for the purchase order amount.

Purchase Order Cancellation Request Line

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order line.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}CancelOrderLine

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Cancellation Request Schedule

Contained by

Purchase Order Cancellation Request

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

CancelOrderSchedule

Purchase Order Cancellation Request Schedule

The criteria for canceling a purchase order schedule.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

LineNumber

decimal

The unique identifier of a line on a document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Purchase Order Cancellation Request Schedule

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order schedule.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}CancelOrderSchedule

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Cancellation Request Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

Purchase Order Change Confirmation

An object, representing a set of parameters, that is returned after a successful completion of create, change, or cancel operation on a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}RequestResults

Relationships

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

Relationship Type Object or Service

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

ChangeOrderNumber

string

The unique identifier of a change order for a document.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

RequestStatus

string

The result of the request for which the service was invoked.

SoldToBUId

long

The unique identifier of the business unit that is liable for the purchase order amount.

Purchase Order Distribution

An object, representing a set of distribution attributes, that is returned when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderDistribution

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Distribution Flexfield

Contained by

Purchase Order Schedule

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

DeliverToLocationCode

string

A code indicating the final delivery location for goods previously received from a supplier.

DeliverToLocationId

long

The unique identifier of a final delivery location for goods previously received from a supplier.

DestinationChargeAccount

string

The account to charge for the cost of this item in the requisitioning business unit.

DestinationChargeAccountId

long

The unique identifier of the account to charge for the cost of this item in the requisitioning business unit.

DestinationSubinventory

string

The display name of a subinventory to which the requested item should be delivered.

DestinationVarianceAccount

string

The account to be charged for any purchase price variance for the purchase in the requisitioning business unit, if the requisitioning business unit is different than the sold-to business unit.

DestinationVarianceAccountId

long

The unique identifier of the account to be charged for any purchase price variance for the purchase in the requisitioning business unit, if the requisitioning business unit is different than the sold-to business unit.

DistributionFlexfield

Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and retrieve values for these additional attributes when inquiring a purchase order distribution.

DistributionNumber

decimal

Unique identifier of the distribution associated with a schedule. A distribution is an entity on a purchase order where charge accounts and project information are captured.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

POAccrualAccount

string

The account to be charged for receipt accrual when the requisitioning and sold-to business units are the same.

POAccrualAccountId

long

The unique identifier of the account to be charged for receipt accrual when the requisitioning and sold-to business units are the same.

POChargeAccount

string

The account to be charged for the purchase when the requisitioning and sold-to business units are the same.

POChargeAccountId

long

The unique identifier o the account to be charged for the purchase when the requisitioning and sold-to business units are the same.

POVarianceAccount

string

The account to be charged for any price difference between the invoice and the order.

POVarianceAccountId

long

The unique identifier of the account to be charged for any price difference between the invoice and the order.

Quantity

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

The ordered quantity for the purchase order distribution.

RequesterId

long

The unique identifier of the requester.

RequesterName

string

The name of the requester.

Requisition

string

The number used to identify the requisition.

RequisitionLine

decimal

The requisition line number of the requested item. A requisition can include multiple requested items each identified by a line number.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and retrieve values for these additional attributes, when inquiring a purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchaseOrderDistribution/}PODistributionDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Distribution Version 2

Contained by

Purchase Order Distribution

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoDistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Header

An object, representing a set of header attributes, that is returned when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrder

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Header Flexfield

Contains

Purchase Order Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgmentDueDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when the supplier is requested to acknowledge the document.

BillToLocationCode

string

The code of the location to which the supplier should send the invoice.

BillToLocationId

long

The unique identifier of the location to which the supplier should send the invoice.

BuyerEmail

string

The email address of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerId

long

The unique identifier of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerName

string

The display name of a buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ConfirmingOrderFlag

boolean

Indicates whether the document is a confirmation of an order the supplier may already be aware of.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

ConversionRateType

string

The display name indicating the type of conversion rate, such as user defined, spot, or corporate.

ConversionRateTypeCode

string

A code indicating the type of currency conversion rate, such as user defined, spot, or corporate.

CreationDate

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

The date when the purchasing document is created.

Currency

string

The display name of the three-letter ISO code associated with a currency.

CurrencyCode

string

A code indicating the three-letter ISO code associated with a currency.

DefaultShipToLocationCode

string

The code of the ship-to location that is defaulted automatically while creating an order.

DefaultShipToLocationId

long

The unique identifier of the ship-to location that is defaulted automatically while creating an order.

DocumentDescription

string

Text describing an order or an agreement.

DocumentFiscalClassification

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentFiscalClassificationCode

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentStatus

string

Indicates the state the purchasing document is in relative to the entire document lifecycle.

DocumentStatusCode

string

A code indicating the state the purchasing document is in relative to the entire document lifecycle.

DocumentStyle

string

The name of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentStyleId

long

The unique identifier of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

DocumentTypeCode

string

A code indicating a particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

FOB

string

The point or location where the ownership title of goods is transferred from the seller to the buyer.

FOBCode

string

The code of the point or location where the ownership title of goods is transferred from the seller to the buyer.

FreightTerms

string

A commercial term that indicates who pays the charge for transporting the goods by common carrier.

FreightTermsCode

string

A code for a commercial term that indicates who pays the charge for transporting the goods by common carrier.

HeaderFlexfield

Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes and retrieve values for these additional attributes when inquiring a purchase order.

InterfaceSourceCode

string

A code that indicates the outside source that the data was imported from.

NoteToReceiver

string

Special text instructions to the receiver in the docking area, to be reviewed while performing the receipt.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

OrderNumber

string

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

OrderRevision

decimal

A number that distinguishes printed purchase agreement versions. Each document you print displays the current revision number.

OrderedAmount

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

The total amount of the order, according to the quantities and prices of the goods and service items specified on the order.

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

PayOnReceiptFlag

boolean

Indicates whether the supplier should be paid as soon as the receipt is performed. This can happen only if enabled on the supplier.

PaymentTerms

string

Term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

PaymentTermsId

long

The unique identifier of the term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

ProcurementBUId

long

The unique identifier of the business unit that manages and owns the purchasing document.

ProcurementBusinessUnit

string

The business unit that manages and owns the purchasing document.

ProcurementCard

string

The procurement card account number that the supplier will charge after delivering the goods or services ordered on the document.

PurchaseOrderLine

Purchase Order Line

The purchase order line information.

ReferenceNumber

string

The display number used to identify an imported purchase order from a legacy system.

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequisitioningBUId

long

The unique identifier of the business unit of the requisition.

RequisitioningBusinessUnit

string

Business unit of the requisition.

SoldToBUId

long

The unique identifier of the business unit that is liable for the purchase order amount.

SoldToBusinessUnit

string

The name of the business unit that is liable for the purchase order amount.

Supplier

string

Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierCommunicationEmail

string

The email address specified on the document to which the document after approval will be communicated.

SupplierCommunicationFax

string

The fax number specified on the document to which the document after approval will be communicated.

SupplierCommunicationMethod

string

Indicates how the document should be communicated to the supplier such as email, fax, or EDI.

SupplierContactEmail

string

The email address for a supplier employee who represents the supplier in communications with the buying organization.

SupplierContactId

long

The unique identifier of the employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierContactName

string

Employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierId

long

The unique identifier of the organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierOrderNumber

string

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

SupplierSiteCode

string

A code indicating an entity that models how the buying organization conducts business with the supplier.

SupplierSiteId

long

The unique identifier of the entity that models how the buying organization conducts business with the supplier.

TaxationCountry

string

The country where the transaction is deemed to have taken place for taxation purposes.

TaxationCountryCode

string

The code of the country where the transaction is deemed to have taken place for taxation purposes.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and retrieve values for these additional attributes when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentHeader/}POHeaderDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Header Version 2

Contained by

Purchase Order Header

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Line

An object, representing a set of line attributes, that is returned when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderLine

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Line Flexfield

Contains

Purchase Order Schedule

Contained by

Purchase Order Header

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

CategoryId

long

The unique identifier of the code used to group items with similar characteristics.

CategoryName

string

The display name of a category used to group items with similar characteristics.

HazardClass

string

Name to identify and classify hazardous materials, to facilitate safety regulations compliance.

HazardClassDescription

string

Description of the classification of hazardous materials used to facilitate safety regulations compliance.

HazardClassId

long

The unique identifier of the classification of hazardous materials used to facilitate safety regulations compliance.

ItemDescription

string

Text that describes the item being purchased.

ItemId

long

The unique identifier of an item.

ItemNumber

string

The display name of an item representing anything you make, purchase, or sell, including components, subassemblies, finished products, or supplies.

ItemRevision

string

Identifier that indicates version of inventory item being referenced on the order line.

LineFlexfield

Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes, and retrieve values for these additional attributes when inquiring a purchase order line.

LineNumber

decimal

The unique identifier of a line on a document.

LineStatus

string

A name that indicates the state of the line relative to the entire line lifecycle.

LineStatusCode

string

A code that indicates the state of the line relative to the entire line lifecycle.

LineType

string

A type to indicate whether a purchasing document line is for goods or services, as well as some default attributes associated with the line.

LineTypeId

long

The unique identifier of a type to indicate whether a purchasing document line is for goods or services, as well as to default some attributes associated with the line.

NegotiatedFlag

boolean

Indicates that the price on the document line is a value agreed on in advance during discussions between the buyer and the supplier.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Price

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

Price of the item on the document line.

PurchaseOrderSchedule

Purchase Order Schedule

The purchase order schedule information.

Quantity

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

The ordered quantity for the purchase order line.

SourceAgreementId

long

The unique identifier of the purchase agreement against which this purchase order line is released.

SourceAgreementLine

decimal

The purchase agreement line against which this purchase order line is released.

SourceAgreementNumber

string

The purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBUId

long

The unique identifier of the procurement business unit of the purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBusinessUnit

string

The name of the procurement business unit of the purchase agreement against which this purchase order line is released.

SourceAgreementStyle

string

The style of the purchase agreement against which this purchase order line is released.

SourceAgreementType

string

The document type of the purchase agreement against which this purchase order line is released.

SupplierConfigurationId

string

The identifier of the order (configuration) that the requester created in the supplier's system while creating a requisition while placing an order in the supplier's shopping web store.

SupplierItem

string

The supplier's identification number or code for the goods ordered on your order line.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

UNNumber

string

The United Nations identification number for the hazardous material.

UNNumberDescription

string

Text describing the hazardous material associated with this UN Number.

UNNumberId

long

The unique identifier of the United Nations identification number for the hazardous material.

UnitOfMeasure

string

A division of quantity defined as a standard of measurement or exchange.

UnitOfMeasureCode

string

A code indicating a division of quantity defined as a standard of measurement or exchange.

Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes and retrieve values for these additional attributes when inquiring a purchase order line.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentLine/}POLineDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Line

Contained by

Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Schedule

An object, representing a set of schedule attributes, that is returned when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseOrderService/}PurchaseOrderSchedule

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Schedule Flexfield

Contains

Purchase Order Distribution

Contained by

Purchase Order Line

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

AccrueAtReceiptFlag

boolean

Indicates whether the purchase order schedule will be accrued at receipt.

AllowSubstituteReceiptsFlag

boolean

Indicates whether the purchase order schedule can receive substitute item in place of an ordered item.

AssessableAmount

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

The price at which a product is valued by a tax authority, for tax calculation purposes. The same product can have more than one assessable value, as given by different tax authorities.

CountryOfOrigin

string

The display name of a country from which goods are exported.

CountryOfOriginCode

string

A code indicating the country from which goods are exported.

DestinationType

string

The display name indicating if the item should be charged to an inventory or should be expensed.

DestinationTypeCode

string

A code indicating if the item should be charged to an inventory or should be expensed.

EarlyReceiptToleranceDays

decimal

Maximum acceptable number of days early for receipts.

IntendedUse

string

A tax classification based on the purpose for which a product is used.

IntendedUseId

long

The unique identifier of the tax classification based on the purpose for which a product is used.

InvoiceCloseTolerancePercent

decimal

The tolerance that allows a purchase order schedule to be automatically closed for invoicing, if it is within the tolerance at billing, when Payables matches invoices to purchase orders or receipts.

InvoiceMatchOption

string

The option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

InvoiceMatchOptionCode

string

The code associated with the option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

LastAcceptDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The last date when the ordered quantity or amount can be received.

LateReceiptToleranceDays

decimal

Maximum acceptable number of days late for receipts.

MatchApprovalLevelCode

string

A code that indicates how purchase order, receipt, inspection, and invoice quantities should match before the corresponding invoice can be paid.

NeedByDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the buying company requests the supplier to deliver the item.

NoteToReceiver

string

Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

OriginalPromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The first promised date recorded for a purchase order schedule.

OverReceiptAction

string

Determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptActionCode

string

A code that determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptTolerancePercent

decimal

The tolerance that allows a purchase order schedule to receive more than ordered quantity or amount without triggering the over-receipt action.

ProductCategory

string

A type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductCategoryCode

string

A code indicating a type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductFiscalClassification

string

A classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductFiscalClassificationId

long

A classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductType

string

The nature or the product involved in a taxable transaction. For example, goods or services.

ProductTypeCode

string

A code indicating a type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

PromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the item ordered by the buying company.

PurchaseOrderDistribution

Purchase Order Distribution

The purchase order distribution information.

Quantity

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

The ordered quantity for the purchase order schedule.

ReceiptCloseTolerancePercent

decimal

The percentage that allows a purchase order schedule to be automatically closed for receiving if it is within the tolerance at receiving.

ReceiptDateExceptionAction

string

The display name of an action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptDateExceptionActionCode

string

A code indicating the action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptRouting

string

A method of simplifying transaction entry by specifying routing steps for receipts.

ReceiptRoutingId

long

The unique identifier of a method of simplifying transaction entry by specifying routing steps for receipts.

ScheduleFlexfield

Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes and retrieve values for these additional attributes when inquiring a purchase order schedule.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

ScheduleStatus

string

The display name of a purchase order schedule state relative to the entire schedule lifecycle.

ScheduleStatusCode

string

A code indicating the state that the purchase order schedule is in relative to the entire schedule lifecycle.

SecondaryQuantity

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

The quantity converted in the secondary unit of measure of a dual UOM controlled item.

SecondaryUOM

string

An alternative unit of measure that is allowed to quantify a dual UOM controlled item.

SecondaryUOMCode

string

A code indicating an alternative unit of measure that is allowed to quantify a dual UOM controlled item.

ShipToExceptionAction

string

The display name of how to handle receipts when the receiving location differs from the ship-to location.

ShipToExceptionActionCode

string

A code indicating how to handle receipts when the receiving location differs from the ship-to location.

ShipToLocationCode

string

A code indicating a location where the supplier should ship the goods.

ShipToLocationId

long

The unique identifier of the location where the supplier should ship the goods.

ShipToOrganizationCode

string

A code indicating an inventory organization where the supplier should ship the goods.

ShipToOrganizationId

long

The unique identifier of the inventory organization where the supplier should ship the goods.

ShipToOrganizationName

string

The name of the inventory organization where the supplier should ship the goods.

SupplierOrderLine

string

The number or text that the supplier uses to identify a purchase order schedule.

TaxClassification

string

The display name of a group of taxes for reporting and processing purposes.

TaxClassificationCode

string

A code indicating a grouping of taxes for reporting and processing purposes.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

TransactionBusinessCategory

string

A business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

TransactionBusinessCategoryCode

string

A code indicating a business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

UserDefinedFiscalClassification

string

A classification for any tax requirement that you cannot define using the existing fiscal classification types.

UserDefinedFiscalClassificationCode

string

A classification code for any tax requirement that you cannot define using the existing fiscal classification types.

Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and retrieve values for these additional attributes, when inquiring a purchase order schedule.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentSchedule/}POScheduleDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Schedule Version 2

Contained by

Purchase Order Schedule

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

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://servername/fscmService/PurchaseOrderServiceV2?WSDL

Relationships

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

Relationship Type Object or Service

Handles

Draft Purchase Order Distribution Projects Flexfield Service Data Object Version 1

Handles

Draft Purchase Order Schedule Flexfield

Handles

Purchase Order Schedule Service Data Object Version 2

Handles

Purchase Order Cancellation Request Schedule Service Data Object Version 2

Handles

Draft Purchase Order Header Service Data Object Version 2

Handles

Purchase Order Header Flexfield

Handles

Draft Purchase Order Distribution Flexfield

Handles

Purchase Order Acknowledgment Confirmation

Handles

Purchase Order Distribution Flexfield

Handles

Draft Purchase Order Line Service Data Object Version 2

Handles

Purchase Order Schedule Acknowledgment Confirmation Service Data Object Version 1

Handles

Purchase Order Schedule Acknowledgment Request

Handles

Draft Purchase Order Line Flexfield

Handles

Draft Purchase Order Schedule Service Data Object Version 2

Handles

Purchase Order Line Flexfield

Handles

Purchase Order Line Service Data Object Version 2

Handles

Purchase Order Distribution Projects Flexfield Service Data Object Version 1

Handles

Purchase Order Configuration Line Service Data Object Version 1

Handles

Purchase Order Cancellation Request Line Service Data Object Version 2

Handles

Purchase Order Header Service Data Object Version 2

Handles

Purchase Order Distribution Service Data Object Version 2

Handles

Purchase Order Schedule Flexfield

Handles

Purchase Order Header Acknowledgment Request

Handles

Draft Purchase Order Distribution Service Data Object Version 2

Handles

Draft Purchase Order Header Flexfield

Handles

Purchase Order Change Confirmation Service Data Object Version 2

Handles

Purchase Order Cancellation Request Service Data Object Version 2

Handles

Draft Purchase Order Configuration Line Service Data Object Version 1

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

Request Payload

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

Request Payload

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

getPurchaseOrder

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.

acknowledgePurchaseOrder

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.

findPurchaseOrderBySupplierOrderNumber

PO_SEARCH_PURCHASE_ORDER_WEB_SERVICE_PRIV

Search Purchase Order by Web Service

Allows searching for purchase orders using the web service.

cancelChangeOrder

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.

cancelPurchaseOrder

PO_MANAGE_PURCHASE_ORDER_WEB_SERVICE_PRIV

Manage Purchase Order by Web Service

Allows management of purchase orders using web service.

Draft Purchase Order Configuration Line Version 1

An object, representing a set of schedule attributes, that is used to provide values while creating or changing a purchase order.

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

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

ComponentLineId

long

The unique identifier of a component.
  • Primary Key

ComponentLineNumber

decimal

The display number used to identify a component.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

Price

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

The unit price of the component.

Draft Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and capture values for these additional attributes, while creating or changing a purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchaseOrderDistribution/}DraftPODistributionDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Distribution Version 2

Contained by

Draft Purchase Order Distribution

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoDistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Distribution Projects Flexfield Version 1

An object that captures the project related attributes on the purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/commonPo/flex/PJCPoDraftDistribution/}PJCDFFPO_5FPurchase_5FOrder

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Distribution Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

FLEX_PARAM_BusinessUnit

decimal

The unique identifier of the requisitioning business unit is passed to this attribute, based on which valid projects are determined.

PoDistributionId

long

_BILLABLE_FLAG

string

Indicates whether the transaction will be billable after it is fully processed or not. Valid values are Y for true, and N for false.

_BILLABLE_FLAG_Display

string

The display name indicating whether the transaction can be capitalized after it is fully processed or not. Valid values are Y for true, and N for false.

_CAPITALIZABLE_FLAG

string

Indicates whether the transaction will be capitalizable after it is fully processed or not. Valid values are Y for true, and N for false.

_CAPITALIZABLE_FLAG_Display

string

The display name indicating whether the transaction will be capitalizable after it is fully processed or not. Valid values are Y for true, and N for false.

_CONTRACT_ID

decimal

The unique identifier of the contract associated with a sponsored project.

_CONTRACT_ID_Display

string

The display number used to identify the contract associated with a sponsored project.

_EXPENDITURE_ITEM_DATE

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when work is performed and is charged to a project and task.

_EXPENDITURE_TYPE_ID

decimal

The unique identifier of the classification of cost assigned to each expenditure item.

_EXPENDITURE_TYPE_ID_Display

string

The display name of the classification of cost assigned to each expenditure item.

_FLEX_NumOfSegments

int

_ORGANIZATION_ID

decimal

The unique identifier of the organization that is incurring the expense on the transaction.

_ORGANIZATION_ID_Display

string

The display name of the organization that is incurring the expense on the transaction.

_PROJECT_ID

decimal

The unique identifier of a project. A project has specific start and finish dates, and is undertaken to create a product or provide a service.

_PROJECT_ID_Display

string

The display name of a project. A project has specific start and finish dates, and is undertaken to create a product or provide a service.

_RESERVED_ATTRIBUTE1

string

The unique identifier of the external or internal party providing financial support to conduct research projects.

_RESERVED_ATTRIBUTE1_Display

string

The display name of the external or internal party providing financial support to conduct research projects.

_TASK_ID

decimal

The unique identifier of a task. A task is s subdivision of project work.

_TASK_ID_Display

string

The display name of a task. A task is a subdivision of project work.

_WORK_TYPE_ID

decimal

The unique identifier of the classification of work associated with a transaction. You can use work types to categorize and group tasks for processing purposes.

_WORK_TYPE_ID_Display

string

The display name of the classification of work associated with a transaction. You can use work types to categorize and group tasks for processing purposes.

__FLEX_Context

string

Draft Purchase Order Distribution Version 2

An object, representing a set of distribution attributes, that is used to provide values while creating or changing a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

Action

string

Indicates the action to be performed at purchase order distribution, such as change or split.

BudgetDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date used to derive the budget period from which budget is consumed.

ChangeReason

string

A text description capturing the reason for changing the entity.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

DeliverToLocationCode

string

A code indicating the final delivery location for goods previously received from a supplier.

DeliverToLocationId

long

The unique identifier of a final delivery location for goods previously received from a supplier.

DestinationChargeAccount

string

The account to charge for the cost of this item in the requisitioning business unit.

DestinationChargeAccountId

long

The unique identifier of the account to charge for the cost of this item in the requisitioning business unit.

DestinationSubinventory

string

The display name of a subinventory to which the requested item should be delivered.

DistributionFlexfield

Draft Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and capture values for these additional attributes while creating or changing a purchase order distribution.

DistributionNumber

decimal

Unique identifier of the distribution associated with a schedule. A distribution is an entity on a purchase order where charge accounts and project information are captured.

DistributionProjectFlexfield

Draft Purchase Order Distribution Projects Flexfield Version 1

An object that captures the project related attributes on the purchase order distribution.

LineLocationId

long

The unique identifier of a purchase order schedule.

OrderedAmount

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

The total amount of the order, according to the quantities and prices of the goods and service items specified on the order.

POChargeAccount

string

The account to be charged for the purchase when the requisitioning and sold-to business units are the same.

POChargeAccountId

long

The unique identifier of the account to be charged for the purchase when the requisitioning and sold-to business units are the same.

PODistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

ParentDistributionId

long

Identifier of the distribution that is being split to create the new distribution.

ParentDistributionNumber

decimal

The number of the distribution that is being split to create the new distribution.

Quantity

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

The ordered quantity for the purchase order distribution.

RequesterEmail

string

The email address of the requester.

RequesterId

long

The unique identifier of the requester.

RequesterName

string

The name of the requester.

Draft Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and capture values for these additional attributes, while creating or changing a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentHeader/}DraftPOHeaderDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Header

Contained by

Draft Purchase Order Header Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Header Version 2

An object, representing a set of header attributes, that is used to provide values while creating or changing a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeWithinDays

decimal

The number of days within which the supplier is requested to acknowledge the document.

ApprovalAction

string

The display name indicating whether to submit the document for approval after import or import document as approved or as draft.

ApprovalActionCode

string

A code indicating whether to submit the document for approval after import or import document as approved or as draft.

BillToBUId

long

The unique identifier of the business unit that processes supplier invoices for the purchase order.

BillToBusinessUnit

string

The display name for the business unit that processes supplier invoices for the purchase order.

BillToLocationCode

string

The code of the location to which the supplier should send the invoice.

BillToLocationId

long

The unique identifier of the location to which the supplier should send the invoice.

BuyerEmail

string

The email address of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerId

long

The unique identifier of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerManagedTransportFlag

boolean

Indicates whether the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order.

BuyerName

string

The display name of a buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ChangeOrderDescription

string

A text description capturing the reason or purpose of the change order.

ChangeOrderInitiatingParty

string

The code indicating the party who originated the purchase document change request. Valid values are Requester, Buyer, Supplier and Catalog Administrator.

ChangeOrderInitiatorEmail

string

The email of the person who originated the purchase document change request.

ChangeOrderInitiatorId

long

The unique identifier of the person who originated the purchase document change request.

ChangeOrderInitiatorName

string

The name of the person who originated the purchase document change request.

ConfirmingOrderFlag

boolean

Indicates whether the document is a confirmation of an order the supplier may already be aware of.

ConsignmentTermsEnabledFlag

boolean

Indicates whether the system should use the seeded consignment document style to create the purchase order. Valid values are Y, N.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

ConversionRateType

string

The display name indicating the type of conversion rate, such as user defined, spot, or corporate.

ConversionRateTypeCode

string

A code indicating the type of currency conversion rate, such as user defined, spot, or corporate.

Currency

string

The display name of the three-letter ISO code associated with a currency.

CurrencyCode

string

A code indicating the three-letter ISO code associated with a currency.

DefaultShipToLocationCode

string

The code of the ship-to location that is defaulted automatically while creating an order.

DefaultShipToLocationId

long

The unique identifier of the ship-to location that is defaulted automatically while creating an order.

DocumentDescription

string

Text describing an order or an agreement.

DocumentFiscalClassification

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentFiscalClassificationCode

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentStyle

string

The name of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentStyleId

long

The unique identifier of the document style, enabled for the purchasing document type, as displayed to the user.

FOB

string

The point or location where the ownership title of goods is transferred from the seller to the buyer.

FOBCode

string

The code of the point or location where the ownership title of goods is transferred from the seller to the buyer.

FirstPartyTaxRegistrationId

long

A unique identifier assigned to a first party, by a tax authority, when it is registered and by which the first party registration will be identified.

FirstPartyTaxRegistrationNumber

string

A unique sequence of letters and/or numbers assigned to a first party, by a tax authority, when it is registered and by which the first party registration will be identified.

FreightTerms

string

A commercial term that indicates who pays the charge for transporting the goods by common carrier.

FreightTermsCode

string

A code for a commercial term that indicates who pays the charge for transporting the goods by common carrier.

HeaderFlexfield

Draft Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and capture values for these additional attributes while creating or changing a purchase order.

InterfaceSourceCode

string

A code that indicates the outside source that the data was imported from.

ModeOfTransport

string

The mode of transport used for shipment.

ModeOfTransportCode

string

The code of the mode of transport used for shipment.

NoteToReceiver

string

Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

OrchestrationOrderFlag

boolean

A purchase order in the supply chain process created for the purpose of executing the financial transactions between two internal organizations. The primary differentiator for 'Orchestration Order' or 'POs created along financial route' is that they are not used for physical execution of supply chain process.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

PayOnReceiptFlag

boolean

Indicates whether the supplier should be paid as soon as the receipt is performed. This can happen only if enabled on the supplier.

PaymentTerms

string

Term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

PaymentTermsId

long

The unique identifier of the term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

ProcurementBUId

long

The business unit that manages and owns the purchasing document.

ProcurementBusinessUnit

string

The business unit that manages and owns the purchasing document.

PurchaseOrderEntryLine

Draft Purchase Order Line Version 2

The purchase order line information.

ReferenceNumber

string

The display number used to identify an imported purchase order from a legacy system.

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequisitioningBUId

long

The unique identifier of the business unit of the requisition.

RequisitioningBusinessUnit

string

Business unit of the requisition.

ServiceLevel

string

The display name of a transportation priority that affects how quickly goods are transported. Applicable values are all meanings of the lookup Carrier Service Levels.

ServiceLevelCode

string

A code indicating the priority of transportation that affects how quickly goods are transported. Applicable values are all codes of the lookup Carrier Service Levels.

SoldToLegalEntity

string

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

SoldToLegalEntityId

long

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

Supplier

string

Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierCommunicationEmail

string

The email address specified on the document to which the document after approval will be communicated.

SupplierCommunicationFax

string

The fax number specified on the document to which the document will be communicated after approval .

SupplierCommunicationMethod

string

Indicates how the document should be communicated to the supplier, such as email, fax, or EDI.

SupplierCommunicationMethodCode

string

A code indicating how the document should be communicated to the supplier, such as email, fax, or EDI.

SupplierContactEmail

string

The email address for a supplier employee who represents the supplier in communications with the buying organization.

SupplierContactId

long

The unique identifier of the employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierContactName

string

Employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierId

long

The unique identifier of the organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierOrderNumber

string

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

SupplierSiteCode

string

A code indicating an entity that models how the buying organization conducts business with the supplier.

SupplierSiteId

long

The unique identifier of the entity that models how the buying organization conducts business with the supplier.

TaxationCountry

string

The country where the transaction is deemed to have taken place for taxation purposes.

TaxationCountryCode

string

The code of the country where the transaction is deemed to have taken place for taxation purposes.

ThirdPartyTaxRegistrationId

long

A unique identifier of the registration number assigned to the supplier or supplier site, when it is registered by a tax authority, and by which the party or party site registration will be identified.

ThirdPartyTaxRegistrationNumber

string

A unique sequence of letters and/or numbers assigned to the supplier or supplier site, when it is registered by a tax authority, and by which the party or party site registration will be identified.

Draft Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes, and capture values for these additional attributes, while creating or changing a purchase order line.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentLine/}DraftPOLineDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Line

Contained by

Draft Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Line Version 2

An object, representing a set of line attributes, that is used to provide values while creating or changing a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

Action

string

Indicates the action to be performed at purchase order line, such as add, change, or cancel.

BaseModelPrice

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

The model price from which an ATO configuration was created.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel the backing requisition, if one exists, when canceling a line or a schedule.

CategoryId

long

The unique identifier of the code used to group items with similar characteristics.

CategoryName

string

The display name of a category used to group items with similar characteristics.

ChangeReason

string

A text description capturing the reason for changing the entity.

HazardClass

string

Name to identify and classify hazardous materials, to facilitate safety regulations compliance.

HazardClassId

long

The unique identifier of the classification of hazardous materials used to facilitate safety regulations compliance.

ItemDescription

string

Text that describes the item being purchased.

ItemId

long

The unique identifier of an item.

ItemNumber

string

The display name of an item representing anything you make, purchase, or sell, including components, subassemblies, finished products, or supplies.

ItemRevision

string

Identifier that indicates version of inventory item being referenced on the order line.

LineFlexfield

Draft Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes, and capture values for these additional attributes while creating or changing a purchase order line.

LineNumber

decimal

The unique identifier of a line on a document.

LineType

string

A type to indicate whether a purchasing document line is for goods or services, as well as some default attributes associated with the line.

LineTypeId

long

The unique identifier of a type to indicate whether a purchasing document line is for goods or services, as well as to default some attributes associated with the line.

NegotiatedFlag

boolean

Indicates that the price on the document line is a value agreed on in advance during discussions between the buyer and the supplier.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Price

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

Price of the item on the document line.

PurchaseOrderEntryConfigLine

Draft Purchase Order Configuration Line Version 1

The set of configuration line attributes returned when updating a purchase order.

PurchaseOrderEntrySchedule

Draft Purchase Order Schedule Version 2

The purchase order schedule information.

Quantity

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

The ordered quantity for the purchase order line.

SourceAgreementId

long

The unique identifier of the purchase agreement against which this purchase order line is released.

SourceAgreementLine

decimal

The purchase agreement line against which this purchase order line is released.

SourceAgreementNumber

string

The purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBUId

long

The unique identifier of the procurement BU of the purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBusinessUnit

string

The name of the procurement BU of the purchase agreement against which this purchase order line is released.

SupplierItem

string

The supplier's identification number or code for the goods ordered on your order line.

UNNumber

string

The United Nations identification number for the hazardous material.

UNNumberId

long

The unique identifier of the United Nations identification number for the hazardous material.

UnitOfMeasure

string

A division of quantity defined as a standard of measurement or exchange.

UnitOfMeasureCode

string

A code indicating a division of quantity defined as a standard of measurement or exchange.

Draft Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and capture values for these additional attributes, while creating or changing a purchase order schedule.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/flex/draftPurchasingDocumentSchedule/}DraftPOScheduleDFF

Relationships

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

Relationship Type Object or Service

Contained by

Draft Purchase Order Schedule Version 2

Contained by

Draft Purchase Order Schedule

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Draft Purchase Order Schedule Version 2

An object, representing a set of schedule attributes, that is used to provide values while creating or changing a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

AccrueAtReceiptFlag

boolean

Indicates whether the purchase order schedule will be accrued at receipt.

Action

string

Indicates the action to be performed at purchase order schedule, such as change, split, or cancel.

AllowSubstituteReceiptsFlag

boolean

Indicates whether the purchase order schedule can receive a substitute item in place of an ordered item.

AssessableAmount

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

The price at which a product is valued, by a tax authority, for tax calculation purposes. The same product can have more than one assessable value, as given by different tax authorities.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel the backing requisition, if one exists, when canceling a line or a schedule.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ChangeReason

string

A text description capturing the reason for changing the entity.

CountryOfOrigin

string

The display name of a country from which goods are exported.

CountryOfOriginCode

string

A code indicating the country from which goods are exported.

DestinationType

string

The display name indicating if the item should be charged to an inventory or should be expensed.

DestinationTypeCode

string

A code indicating if the item should be charged to an inventory or should be expensed.

EarlyReceiptToleranceDays

decimal

Maximum acceptable number of days early for receipts.

IntendedUse

string

A tax classification based on the purpose for which a product is used.

IntendedUseId

long

The unique identifier of the tax classification based on the purpose for which a product is used.

InvoiceCloseTolerancePercent

decimal

The tolerance that allows a purchase order schedule to be automatically closed for invoicing, if it is within the tolerance at billing, when Payables matches invoices to purchase orders or receipts.

InvoiceMatchOption

string

The option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

InvoiceMatchOptionCode

string

The code associated with the option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

LateReceiptToleranceDays

decimal

Maximum acceptable number of days late for receipts.

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

LocationOfFinalDischargeCode

string

The final destination location for the purchases made by the customer. The location of the final customer, or where the goods would be used, is not necessarily the same as the initial ship-to location.

LocationOfFinalDischargeId

long

The unique identifier of a final destination location for the purchases made by the customer. The location of the final customer, or where the goods would be used, is not necessarily the same as the initial ship-to location.

MatchApprovalLevelCode

string

A code that indicates how purchase order, receipt, inspection, and invoice quantities should match before the corresponding invoice can be paid.

ModeOfTransport

string

The mode of transport used for shipment.

ModeOfTransportCode

string

The code of the mode of transport used for shipment.

NeedByDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the buying company requests the supplier to deliver the item.

NoteToReceiver

string

Special text instructions to the receiver in the docking area to be reviewed while performing the receipt.

OrderedAmount

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

The total amount of the order, according to the quantities and prices of the goods and service items specified on the order.

OverReceiptAction

string

Determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptActionCode

string

A code that determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptTolerancePercent

decimal

The tolerance that allows a purchase order schedule to receive more than the ordered quantity or amount, without triggering the over-receipt action.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

ParentLineLocationId

long

Identifier of the schedule that is being split to create the new schedule.

ParentScheduleNumber

decimal

The number of the schedule that is being split to create the new schedule.

ProductCategory

string

A type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductCategoryCode

string

A code associated with a type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductFiscalClassification

string

A classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductFiscalClassificationId

long

The unique identifier of the classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductType

string

The nature or the product involved in a taxable transaction. For example, goods or services.

ProductTypeCode

string

A code indicating the nature or the product involved in a taxable transaction. For example, goods or services.

PromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the item ordered by the buying company.

PromisedDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the ordered item or service.

PromisedShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to ship the item ordered by the buying company.

PurchaseOrderEntryDistribution

Draft Purchase Order Distribution Version 2

The purchase order distribution information.

Quantity

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

The ordered quantity for the purchase order schedule.

ReceiptCloseTolerancePercent

decimal

The percentage that allows a purchase order schedule to be automatically closed for receiving, if it is within the tolerance at receiving.

ReceiptDateExceptionAction

string

The display name of an action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptDateExceptionActionCode

string

A code indicating the action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptRouting

string

A method of simplifying transaction entry by specifying routing steps for receipts.

ReceiptRoutingId

long

The unique identifier of a method of simplifying transaction entry by specifying routing steps for receipts.

RequestedDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date that the buying company requests the ordered item or service to be delivered.

RequestedShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when the buying company has requested the ordered item is ready to be shipped.

ScheduleFlexfield

Draft Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and capture values for these additional attributes, while creating or changing a purchase order schedule.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

SecondaryQuantity

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

The quantity converted in the secondary unit of measure of a dual UOM controlled item.

SecondaryUOM

string

An alternative unit of measure that is allowed to quantify a dual UOM controlled item.

SecondaryUOMCode

string

A code indicating an alternative unit of measure that is allowed to quantify a dual UOM controlled item.

ServiceLevel

string

The display name of a transportation priority that affects how quickly goods are transported. Applicable values are all meanings of the lookup Carrier Service Levels.

ServiceLevelCode

string

A code indicating the priority of transportation that affects how quickly goods are transported. Applicable values are all codes of the lookup Carrier Service Levels.

ShipToExceptionAction

string

The display name of how to handle receipts when the receiving location differs from the ship-to location.

ShipToExceptionActionCode

string

A code indicating how to handle receipts when the receiving location differs from the ship-to location.

ShipToLocationCode

string

A code indicating a location where the supplier should ship the goods.

ShipToLocationId

long

The unique identifier of the location where the supplier should ship the goods.

ShipToOrganizationCode

string

A code indicating an inventory organization where the supplier should ship the goods.

ShipToOrganizationId

long

The unique identifier of the inventory organization where the supplier should ship the goods.

SupplierOrderLine

string

The number or text that the supplier uses to identify a purchase order schedule.

TaxClassification

string

The display name of a group of taxes for reporting and processing purposes.

TaxClassificationCode

string

A code indicating a grouping of taxes for reporting and processing purposes.

TransactionBusinessCategory

string

A business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

TransactionBusinessCategoryCode

string

A code indicating a business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

UserDefinedFiscalClassification

string

A classification for any tax requirement that you cannot define using the existing fiscal classification types.

UserDefinedFiscalClassificationCode

string

A classification code for any tax requirement that you cannot define using the existing fiscal classification types.

Purchase Order Acknowledgment Confirmation

An object, representing a set of parameters, that is returned after a successful completion of an acknowledge operation on a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeRequestScheduleResults

Purchase Order Schedule Acknowledgment Confirmation Version 1

List of errors encountered while acknowledging a purchase order at either header or schedule level.

RequestStatus

string

The result of the request for which the service was invoked.

Purchase Order Cancellation Request Line Version 2

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order line.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

CancelOrderSchedule

Purchase Order Cancellation Request Schedule Version 2

The criteria for canceling a purchase order schedule.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

LineNumber

decimal

The unique identifier of a line on a document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Purchase Order Cancellation Request Schedule Version 2

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order schedule.

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

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Cancellation Request Line Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

Purchase Order Cancellation Request Version 2

An object, representing a set of attributes, used to initiate a cancellation request on a purchase order.

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

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Cancellation Request Line Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeWithinDays

decimal

The number of days within which the supplier is requested to acknowledge the document.

CancelOrderLine

Purchase Order Cancellation Request Line Version 2

The criteria for canceling a purchase order line.

CancelReason

string

A text description capturing user entered comments provided during a cancellation request.

CancelRequisitionFlag

boolean

Indicates whether to cancel all associated requisitions while canceling an order, line or schedule.

CanceledByRole

string

The role or party initiating a document cancellation request. It can be a buyer or a supplier.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

SoldToLegalEntity

string

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

SoldToLegalEntityId

long

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

Purchase Order Change Confirmation Version 2

An object, representing a set of parameters, that is returned after successful completion of a create, change, or cancel operation on a purchase order.

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

Relationships

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

Relationship Type Object or Service

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

ChangeOrderNumber

string

The unique identifier of a change order for a document.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

RequestStatus

string

The result of the request for which the service was invoked.

SoldToLegalEntityId

long

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

Purchase Order Configuration Line Version 1

An object, representing a set of configuration line attributes, that is returned when inquiring a purchase order.

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

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

BaseModelId

long

The unique identifier of a model from which an ATO configuration was created.

BaseModelNumber

string

The display name of a model from which an ATO configuration was created.

ComponentLineId

long

The unique identifier of a component.
  • Primary Key

ComponentLineNumber

decimal

The display number used to identify a component.

ExtendedPrice

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

Extended price of the option (quantity times price). An option is a configurable add-on that is part of a larger configuration.

ItemDescription

string

A text description capturing details about the component used in the configuration.

ItemId

long

The unique identifier of an item.

ItemNumber

string

The display name of an item representing anything you make, purchase, or sell, including components, subassemblies, finished products, or supplies.

ItemRevision

string

Identifier that indicates the version of the inventory item being referenced on the order line.

ItemType

string

A code indicating the item type. Valid values include configured item, option class, or option.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

ParentComponentLineId

long

The unique identifier of the parent component line. If the parent is the base model, this field will be null.

Price

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

The unit price of the component.

Quantity

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

The quantity indicating the number of units needed to complete a single configuration.

SourceAgreementId

long

The unique identifier of the purchase agreement against which this purchase order component line is released.

SourceAgreementLine

decimal

The purchase agreement line against which this purchase order component line is released.

SourceAgreementLineId

long

The unique identifier of a purchase agreement line against which this purchase order component line is released.

SourceAgreementNumber

string

The purchase agreement against which this purchase order component line is released.

SupplierItem

string

The display name of a supplier's identification number or code for the goods ordered on your order line.

UnitOfMeasure

string

A division of quantity defined as a standard of measurement or exchange.

UnitOfMeasureCode

string

A code indicating the division of quantity defined as a standard of measurement or exchange.

Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and retrieve values for these additional attributes, when inquiring a purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchaseOrderDistribution/}PODistributionDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Distribution Version 2

Contained by

Purchase Order Distribution

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoDistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Distribution Projects Flexfield Version 1

An object that captures the project related attributes on the purchase order distribution.

QName: {http://xmlns.oracle.com/apps/prc/po/publicEntity/flex/PJCPoTransDistribution/}PJCDFF

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Distribution Version 2

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoDistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the project descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield storing Projects information.

Purchase Order Distribution Version 2

An object, representing a set of distribution attributes, that is returned when inquiring a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

DeliverToCustomer

string

The display name of a customer to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerContact

string

The display name of a customer contact to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerContactId

long

The unique identifier of a customer contact to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerId

long

The unique identifier of a customer to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerLocation

string

The display name of a customer location to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerLocationId

long

The unique identifier of a customer location to whom materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToLocationCode

string

A code indicating the final delivery location for goods previously received from a supplier.

DeliverToLocationId

long

The unique identifier of a final delivery location for goods previously received from a supplier.

DestinationChargeAccount

string

The account to charge for the cost of this item in the requisitioning business unit.

DestinationChargeAccountId

long

The unique identifier of the account to charge for the cost of this item in the requisitioning business unit.

DestinationSubinventory

string

The display name of a subinventory to which the requested item should be delivered.

DestinationVarianceAccount

string

The account to be charged for any purchase price variance for the purchase in the requisitioning BU, if the requisitioning BU is different than the sold-to BU.

DestinationVarianceAccountId

long

The unique identifier of the account to be charged for any purchase price variance for the purchase in the requisitioning BU, if the requisitioning BU is different than the sold-to BU.

DistributionFlexfield

Purchase Order Distribution Flexfield

An object that enables customers to extend the purchase order distribution attributes, and retrieve values for these additional attributes when inquiring a purchase order distribution.

DistributionNumber

decimal

Unique identifier of the distribution associated with a schedule. A distribution is an entity on a purchase order where charge accounts and project information are captured.

DistributionProjectFlexfield

Purchase Order Distribution Projects Flexfield Version 1

An object that captures the project related attributes on the purchase order distribution.

FundsStatus

string

Status of funds check or funds reservation validation result.

FundsStatusCode

string

Status code of funds check or funds reservation validation result.

LineLocationId

long

The unique identifier of a purchase order schedule.

NonrecoverableExclusiveTaxAmount

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

Tax amount that is not included in the ordered amount and cannot be recovered.

NonrecoverableInclusiveTaxAmount

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

Tax amount that is included in the ordered amount and cannot be recovered.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

POAccrualAccount

string

The account to be charged for receipt accrual when the requisitioning and sold-to business units are the same.

POAccrualAccountId

long

The unique identifier of the account to be charged for receipt accrual when the requisitioning and sold-to business units are the same.

POChargeAccount

string

The account to be charged for the purchase when the requisitioning and sold-to business units are the same.

POChargeAccountId

long

The unique identifier of the account to be charged for the purchase when the requisitioning and sold-to business units are the same.

PODistributionId

long

The unique identifier of a purchase order distribution.
  • Primary Key

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

POVarianceAccount

string

The account to be charged for any price difference between the invoice and the order.

POVarianceAccountId

long

The unique identifier of the account to be charged for any price difference between the invoice and the order.

ParentDistributionId

long

Identifier of the distribution that is being split to create the new distribution.

ParentDistributionNumber

decimal

The number of the distribution that is being split to create the new distribution.

ParentScheduleNumber

decimal

The number of the schedule that is being split to create the new schedule.

Quantity

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

The ordered quantity for the purchase order distribution.

RecoverableExclusiveTaxAmount

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

The tax amount that is not included in the ordered amount and can be recovered.

RecoverableInclusiveTaxAmount

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

The tax amount that is included in the ordered amount and can be recovered.

RequesterId

long

The unique identifier of the requester.

RequesterName

string

The name of the requester.

Requisition

string

The number used to identify the requisition.

RequisitionLine

decimal

The requisition line number of the requested item. A requisition can include multiple requested items each identified by a line number.

SoldToLegalEntityId

long

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

TaxExclusiveAmount

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

Ordered amount exclusive of all the transaction taxes involved.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

Purchase Order Header Acknowledgment Request

An object, representing a set of attributes, used to provide acknowledgment response and additional information for a purchase order that is pending supplier acknowledgment.

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

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Schedule Acknowledgment Request

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgeOrderSchedule

Purchase Order Schedule Acknowledgment Request

An object, representing a set of schedule attributes, used to provide acknowledgment response and additional information for a purchase order schedule that is pending supplier acknowledgment.

AcknowledgmentNote

string

The note entered by the user while acknowledging the document.

AcknowledgmentResponse

string

Indicates whether the user accepted or rejected the document while acknowledging the document.

ChangeOrderNumber

long

The unique identifier of a change order for a document.

OrderNumber

string

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

POHeaderId

long

The unique identifier of a purchasing document.

SoldToLEId

long

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

SoldToLEName

string

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

SupplierOrderNumber

string

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

Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and retrieve values for these additional attributes when inquiring a purchase order.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentHeader/}POHeaderDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Header Version 2

Contained by

Purchase Order Header

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Header Version 2

An object, representing a set of header attributes, that is returned when inquiring a purchase order.

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

Relationships

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

Relationship Type Object or Service

Contains

Purchase Order Line Version 2

Contains

Purchase Order Header Flexfield

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

AcknowledgmentDueDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when the supplier is requested to acknowledge the document.

BillToBUId

long

The unique identifier of the business unit that processes supplier invoices for the purchase order.

BillToBusinessUnit

string

The display name for the business unit that processes supplier invoices for the purchase order.

BillToLocationCode

string

The code of the location to which the supplier should send the invoice.

BillToLocationId

long

The unique identifier of the location to which the supplier should send the invoice.

BuyerEmail

string

The email address of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerId

long

The unique identifier of the buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

BuyerManagedTransportFlag

boolean

Indicates whether the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order.

BuyerName

string

The display name of a buyer specified on the document. A buyer is a person responsible for placing item resupply orders with suppliers and negotiating supplier contracts.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ConfirmingOrderFlag

boolean

Indicates whether the document is a confirmation of an order the supplier may already be aware of.

ConversionDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date as of which a conversion rate is used to convert an amount into another currency.

ConversionRate

decimal

The rate at which the principal unit of one currency can be converted into another currency.

ConversionRateType

string

The display name indicating the type of conversion rate, such as user defined, spot, or corporate.

ConversionRateTypeCode

string

A code indicating the type of currency conversion rate, such as user defined, spot, or corporate.

CreationDate

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

The date when the purchasing document is created.

Currency

string

The display name of the three-letter ISO code associated with a currency.

CurrencyCode

string

A code indicating the three-letter ISO code associated with a currency.

DefaultShipToLocationCode

string

The code of the ship-to location that is defaulted automatically while creating an order.

DefaultShipToLocationId

long

The unique identifier of the ship-to location that is defaulted automatically while creating an order.

DocumentDescription

string

Text describing an order or an agreement.

DocumentFiscalClassification

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentFiscalClassificationCode

string

A classification used by a tax authority to categorize a document associated with a transaction for a tax.

DocumentStatus

string

Indicates the state the purchasing document is in relative to the entire document lifecycle.

DocumentStatusCode

string

A code indicating the state the purchasing document is in relative to the entire document lifecycle.

DocumentStyle

string

The name of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentStyleId

long

The unique identifier of the document style, enabled for the purchasing document type, as displayed to the user.

DocumentType

string

A particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

DocumentTypeCode

string

A code indicating a particular kind of purchasing or negotiation document, such as purchase order, blanket purchase agreement, or auction.

FOB

string

The point or location where the ownership title of goods is transferred from the seller to the buyer.

FOBCode

string

The code of the point or location where the ownership title of goods is transferred from the seller to the buyer.

FreightTerms

string

A commercial term that indicates who pays the charge for transporting the goods by common carrier.

FreightTermsCode

string

A code for a commercial term that indicates who pays the charge for transporting the goods by common carrier.

HeaderFlexfield

Purchase Order Header Flexfield

An object that enables customers to extend the purchase order header attributes, and retrieve values for these additional attributes when inquiring a purchase order.

InterfaceSourceCode

string

A code that indicates the outside source that the data was imported from.

ModeOfTransport

string

The mode of transport used for shipment.

ModeOfTransportCode

string

The code of the mode of transport used for shipment.

NoteToReceiver

string

Special text instructions to the receiver in the docking area, to be reviewed while performing the receipt.

NoteToSupplier

string

Special text instructions to the supplier, to be reviewed while completing your order.

OrchestrationOrderFlag

boolean

A purchase order in the supply chain process, created for the purpose of executing the financial transactions between two internal organizations. The primary differentiator for 'Orchestration Order' or 'POs created along financial route' is that they are not used for physical execution of the supply chain process.

OrderDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when the purchase order was communicated to the supplier.

OrderNumber

string

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

OrderRevision

decimal

A number that distinguishes printed purchase agreement versions. Each document you print displays the current revision number.

OrderedAmount

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

The total amount of the order according to the quantities and prices of the goods and service items specified on the order.

POHeaderId

long

The unique identifier of a purchasing document.
  • Primary Key

PayOnReceiptFlag

boolean

Indicates whether the supplier should be paid as soon as the receipt is performed. This can happen only if enabled on the supplier.

PaymentTerms

string

A term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

PaymentTermsId

long

The unique identifier of the term used to schedule payments and to calculate due dates, discount dates, and discount amounts for each invoice.

ProcurementBUId

long

The unique identifier of the business unit that manages and owns the purchasing document.

ProcurementBusinessUnit

string

The business unit that manages and owns the purchasing document.

ProcurementCard

string

The procurement card account number that the supplier will charge after delivering the goods or services ordered on the document.

PurchaseOrderLine

Purchase Order Line Version 2

The purchase order line information.

ReferenceNumber

string

The display number used to identify an imported purchase order from a legacy system.

RequiredAcknowledgment

string

Indicates whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequiredAcknowledgmentCode

string

A code indicating whether the supplier acknowledgment is required on the document, and if required, at what level it is required.

RequisitioningBUId

long

The unique identifier of the business unit of the requisition.

RequisitioningBusinessUnit

string

Business unit of the requisition.

ServiceLevel

string

The display name of a transportation priority that affects how quickly goods are transported. Applicable values are all meanings of the lookup Carrier Service Levels.

ServiceLevelCode

string

A code indicating the priority of transportation that affects how quickly goods are transported. Applicable values are all codes of the lookup Carrier Service Levels.

SoldToLegalEntity

string

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

SoldToLegalEntityId

long

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

SubmitDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

Date when the document was first submitted for approval.

Supplier

string

Organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierCommunicationEmail

string

The email address specified on the document to which the document after approval will be communicated.

SupplierCommunicationFax

string

The fax number specified on the document to which the document after approval will be communicated.

SupplierCommunicationMethod

string

Indicates how the document should be communicated to the supplier such as email, fax, or EDI.

SupplierContactEmail

string

The email address for a supplier employee who represents the supplier in communications with the buying organization.

SupplierContactFax

string

The fax specified on the document to which the document after approval will be communicated.

SupplierContactId

long

The unique identifier of the employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierContactName

string

Employee of the supplier identified on purchasing documents, who represents the supplier in communications with the buying organization.

SupplierContactPhone

string

The phone number for a supplier employee who represents the supplier in communications with the buying organization.

SupplierId

long

The unique identifier of the organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierNumber

string

The display number used to identify an organization or individual that provides goods or services to the buying organization for payment, bound by a contractual obligation.

SupplierOrderNumber

string

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

SupplierSiteCode

string

A code indicating an entity that models how the buying organization conducts business with the supplier.

SupplierSiteId

long

The unique identifier of the entity that models how the buying organization conducts business with the supplier.

TaxationCountry

string

The country where the transaction is deemed to have taken place for taxation purposes.

TaxationCountryCode

string

The code of the country where the transaction is deemed to have taken place for taxation purposes.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes and retrieve values for these additional attributes when inquiring a purchase order line.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentLine/}POLineDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Line

Contained by

Purchase Order Line Version 2

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

PoLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Line Version 2

An object, representing a set of line attributes, that is returned when inquiring a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

BaseModelId

long

The unique identifier to identify the base model for the item.

BaseModelNumber

string

The display name of a model from which an ATO configuration was created.

BaseModelPrice

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

The model price from which an ATO configuration was created.

CategoryId

long

The unique identifier of the code used to group items with similar characteristics.

CategoryName

string

The display name of a category used to group items with similar characteristics.

ConsignmentLineFlag

boolean

Indicates whether the item will be purchased under consignment arrangement from the supplier. A consignment arrangement is a business process wherein material that is in the possession of one party (for example, customers, dealers, agents), remains the property of another party (for example, the manufacturer) by agreement with those in possession, until the material is consumed.

FundsStatus

string

Status of funds check or funds reservation validation result.

FundsStatusCode

string

Status code of funds check or funds reservation validation result.

HazardClass

string

Name to identify and classify hazardous materials, to facilitate safety regulations compliance.

HazardClassDescription

string

Description of the classification of hazardous materials used to facilitate safety regulations compliance.

HazardClassId

long

The unique identifier of the classification of hazardous materials used to facilitate safety regulations compliance.

ItemDescription

string

A text description capturing details about the item being purchased.

ItemId

long

The unique identifier of an item.

ItemNumber

string

Anything you make, purchase, or sell, including components, subassemblies, finished products, or supplies.

ItemRevision

string

Identifier that indicates version of inventory item being referenced on the order line.

LineFlexfield

Purchase Order Line Flexfield

An object that enables customers to extend the purchase order line attributes, and retrieve values for these additional attributes when inquiring a purchase order line.

LineNumber

decimal

The unique identifier of a line on a document.

LineStatus

string

A name that indicates the state of the line relative to the entire line lifecycle.

LineStatusCode

string

A code that indicates the state of the line relative to the entire line lifecycle.

LineType

string

A type to indicate whether a purchasing document line is for goods or services, as well as some default attributes associated with the line.

LineTypeId

long

The unique identifier of a type to indicate whether a purchasing document line is for goods or services, as well as to default some attributes associated with the line.

NegotiatedFlag

boolean

Indicates that the price on the document line is a value agreed on in advance during discussions between the buyer and the supplier.

NoteToSupplier

string

Special text instructions to the supplier to be reviewed while completing your order.

OrderedAmount

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

The total amount of the order, according to the quantities and prices of the goods and service items specified on the order.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.
  • Primary Key

Price

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

Price of the item on the document line.

PurchaseOrderConfigLine

Purchase Order Configuration Line Version 1

The set of configuration line attributes returned when inquiring on a purchase order.

PurchaseOrderSchedule

Purchase Order Schedule Version 2

The purchase order schedule information.

Quantity

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

The ordered quantity for the purchase order line.

SelectedOptionsPrice

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

Sum of the extended prices of all options chosen, per unit of the purchased configuration. An option is a configurable add-on that is part of a larger configuration.

SourceAgreementId

long

The unique identifier of the purchase agreement against which this purchase order line is released.

SourceAgreementLine

decimal

The purchase agreement line against which this purchase order line is released.

SourceAgreementNumber

string

The purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBUId

long

The unique identifier of the procurement BU of the purchase agreement against which this purchase order line is released.

SourceAgreementProcurementBusinessUnit

string

The name of the procurement BU of the purchase agreement against which this purchase order line is released.

SourceAgreementStyle

string

The style of the purchase agreement against which this purchase order line is released.

SourceAgreementType

string

The document type of the purchase agreement against which this purchase order line is released.

SupplierConfigurationId

string

The identifier of the order (configuration) that the requester created in the supplier's system while creating a requisition while placing an order in the supplier's shopping web store.

SupplierItem

string

The supplier's identification number or code for the goods ordered on your order line.

TaxExclusivePrice

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

Price of the item on the document line, exclusive of all taxes.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

UNNumber

string

The United Nations identification number for the hazardous material.

UNNumberDescription

string

Text describing the hazardous material associated with this UN Number.

UNNumberId

long

The unique identifier of the United Nations identification number for the hazardous material.

UnitOfMeasure

string

A division of quantity defined as a standard of measurement or exchange.

UnitOfMeasureCode

string

A code indicating a division of quantity defined as a standard of measurement or exchange.

WorkOrderProduct

string

The display name of the finished goods product of the contract manufacturing work order.

Purchase Order Schedule Acknowledgment Confirmation Version 1

An object, representing a set of parameters at the schedule level, that is returned after successful completion of the acknowledge operation on a purchase order.

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

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Acknowledgment Confirmation

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineNumber

decimal

The unique identifier of a line on a document.
  • Primary Key

MessageName

string

The code associated with the validation error message.
  • Primary Key

MessageText

string

The text of the validation error message.

MessageType

string

The type of validation error message.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.
  • Primary Key

Purchase Order Schedule Acknowledgment Request

An object, representing a set of schedule attributes, used to provide acknowledgment response and additional information for a purchase order schedule that is pending supplier acknowledgment.

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

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Header Acknowledgment Request

Handled by

Purchase Order Service Version 2

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineLocationId

long

The unique identifier of a purchase order schedule.

LineNumber

decimal

The unique identifier of a line on a document.

RejectionReason

string

Text describing the reason for rejection of the purchase order schedule.

Response

string

Indicates whether the user accepted or rejected the purchase order schedule while acknowledging the document.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

SupplierOrderLine

string

The number or text that the supplier uses to identify a purchase order schedule.

Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and retrieve values for these additional attributes, when inquiring a purchase order schedule.

QName: {http://xmlns.oracle.com/apps/prc/po/viewDocument/publicFlex/purchasingDocumentSchedule/}POScheduleDFFPublic

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Order Schedule Version 2

Contained by

Purchase Order Schedule

Handled by

Purchase Order Service Version 2

Handled by

Purchase Order

Attributes

The following table describes attributes in the service data object.

Name Type Description

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

_FLEX_NumOfSegments

int

The number of segments that are enabled for the descriptive flex.

__FLEX_Context

string

The context of the descriptive flexfield.

Purchase Order Schedule Version 2

An object, representing a set of schedule attributes, that is returned when inquiring a purchase order.

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

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

AccrueAtReceiptFlag

boolean

Indicates whether the purchase order schedule will be accrued at receipt.

AllowSubstituteReceiptsFlag

boolean

Indicates whether the purchase order schedule can receive substitute item in place of an ordered item.

AssessableAmount

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

The price at which a product is valued, by a tax authority, for tax calculation purposes. The same product can have more than one assessable value, as given by different tax authorities.

BackToBackFlag

boolean

Indicates whether the purchase order schedule has a backing sales order that is fulfilled using a back to back order.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ClosedDate

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

The date when a schedule is closed or finally closed.

CountryOfOrigin

string

The display name of a country from which goods are exported.

CountryOfOriginCode

string

A code indicating the country from which goods are exported.

CustomerItem

string

The display name of a customer's identification number or code for the goods ordered on your order line.

CustomerItemDescription

string

A text description capturing a customer's identification number or code for the goods ordered on your order line.

CustomerPOLine

string

The display number used to identify a purchase order line from the customer that originated the sales order which is being fulfilled by the material being procured in a drop ship arrangement.

CustomerPONumber

string

The display number used to identify a purchase order from the customer that originated the sales order which is being fulfilled by the material being procured in a drop ship arrangement.

CustomerPOSchedule

string

The display number used to identify a purchase order schedule from the customer that originated the sales order which is being fulfilled by the material being procured in a drop ship arrangement.

DestinationType

string

The display name indicating if the item should be charged to an inventory or should be expensed.

DestinationTypeCode

string

A code indicating if the item should be charged to an inventory or should be expensed.

EarlyReceiptToleranceDays

decimal

Maximum acceptable number of days early for receipts.

FundsStatus

string

Status of funds check or funds reservation validation result.

FundsStatusCode

string

Status code of funds check or funds reservation validation result.

IntendedUse

string

A tax classification based on the purpose for which a product is used.

IntendedUseId

long

The unique identifier of the tax classification based on the purpose for which a product is used.

InvoiceCloseTolerancePercent

decimal

The tolerance that allows a purchase order schedule to be automatically closed for invoicing, if it is within the tolerance at billing, when Payables matches invoices to purchase orders or receipts.

InvoiceMatchOption

string

The option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

InvoiceMatchOptionCode

string

The code associated with the option that determines whether invoices for the purchase order schedule should match to the purchase order or the receipt.

LastAcceptDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The last date when the ordered quantity or amount can be received.

LastAcceptableDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The last date when the ordered quantity or amount can be received.

LastAcceptableShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The last date when the ordered quantity or amount can be shipped.

LateReceiptToleranceDays

decimal

Maximum acceptable number of days late for receipts.

LineLocationId

long

The unique identifier of a purchase order schedule.
  • Primary Key

MatchApprovalLevelCode

string

A code that indicates how purchase order, receipt, inspection, and invoice quantities should match before the corresponding invoice can be paid.

ModeOfTransport

string

The mode of transport used for shipment.

ModeOfTransportCode

string

The code of the mode of transport used for shipment.

NeedByDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the buying company requests the supplier to deliver the item.

NoteToReceiver

string

Special text instructions to the receiver in the docking area, to be reviewed while performing the receipt.

OrchestrationAgreementLineNumber

long

Number representing a primary route in a supply chain financial orchestration flow.

OrchestrationAgreementNumber

string

An agreement entered into between the legal entities, business units and trade organizations of a corporate group for establishing a trade relationship. An orchestration agreement contains the parties involved in the trade relationship, and the process of financial settlement among them.

OrderedAmount

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

The total amount of the order, according to the quantities and prices of the goods and service items specified on the order.

OriginalPromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The first promised date recorded for a purchase order schedule.

OriginalPromisedDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The initial date by when the supplier has promised to deliver the item or service ordered by the buying company.

OriginalPromisedShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The initial date by when the supplier has promised to ship the item ordered by the buying company.

OverReceiptAction

string

Determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptActionCode

string

A code that determines how to handle receipts that exceed the received quantity tolerance.

OverReceiptTolerancePercent

decimal

The tolerance that allows a purchase order schedule to receive more than ordered quantity or amount without triggering the over-receipt action.

POHeaderId

long

The unique identifier of a purchasing document.

POLineId

long

The unique identifier of a purchasing document line.

ParentLineLocationId

long

Identifier of the schedule that is being split to create the new schedule.

ParentScheduleNumber

decimal

The number of the schedule that is being split to create the new schedule.

PrimaryTradeRelationshipId

long

A unique identifier for the trade relationship between two primary parties in a supply chain financial orchestration flow, such as the relationship between a shipping business unit and a selling business unit in a shipment to an external customer, or between the sold to business unit and receiving business unit in a procurement from external supplier.

ProductCategory

string

A type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductCategoryCode

string

A code indicating a type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

ProductFiscalClassification

string

A classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductFiscalClassificationId

long

The unique identifier of the classification used by a tax authority to categorize a product for a tax. There could be more than one by tax. For example, for Brazil two classifications are required.

ProductType

string

The nature or the product involved in a taxable transaction. For example, goods or services.

ProductTypeCode

string

A code indicating a type of product fiscal classification used to classify products. Related term(s): product fiscal classification.

PromisedDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the item ordered by the buying company.

PromisedDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to deliver the ordered item or service.

PromisedShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date by when the supplier has promised to ship the item ordered by the buying company.

PurchaseOrderDistribution

Purchase Order Distribution Version 2

The purchase order distribution information.

PurchasingTradingOrganization

string

The inventory organization reporting to the sold-to legal entity identified on the purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.

PurchasingTradingOrganizationCode

string

The code of the inventory organization reporting to the sold-to legal entity identified on the purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.

PurchasingTradingOrganizationId

long

The identifier of the inventory organization reporting to the sold-to legal entity identified on the purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.

Quantity

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

The ordered quantity for the purchase order schedule.

ReceiptCloseTolerancePercent

decimal

The percentage that allows a purchase order schedule to be automatically closed for receiving, if it is within the tolerance at receiving.

ReceiptDateExceptionAction

string

The display name of an action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptDateExceptionActionCode

string

A code indicating the action that is triggered when the ordered quantity or amount is not yet received before the late receipt tolerance days.

ReceiptRouting

string

A method of simplifying transaction entry by specifying routing steps for receipts.

ReceiptRoutingId

long

The unique identifier of a method of simplifying transaction entry by specifying routing steps for receipts.

ReopenFinalCloseDate

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

The date on which a finally closed schedule is reopened.

RequestedDeliveryDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

A date when the buying company requests the ordered item or service to be delivered.

RequestedShipDate

{http://xmlns.oracle.com/adf/svc/types/}date-Date

The date when the buying company has requested the ordered item is ready to be shipped.

SalesOrderLineNumber

string

The display number used to identify a backing customer sales order line number.

SalesOrderNumber

string

The display number used to identify a backing customer sales order number.

SalesOrderScheduleNumber

string

The display number used to identify a backing customer sales order schedule number.

ScheduleFlexfield

Purchase Order Schedule Flexfield

An object that enables customers to extend the purchase order schedule attributes, and retrieve values for these additional attributes when inquiring a purchase order schedule.

ScheduleNumber

decimal

The display number used to identify a purchase order schedule associated with a line.

ScheduleStatus

string

The display name of a purchase order schedule state relative to the entire schedule lifecycle.

ScheduleStatusCode

string

A code indicating the state that the purchase order schedule is in relative to the entire schedule lifecycle.

SecondaryQuantity

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

The quantity converted in the secondary unit of measure of a dual UOM controlled item.

SecondaryUOM

string

An alternative unit of measure that is allowed to quantify a dual UOM controlled item.

SecondaryUOMCode

string

A code indicating an alternative unit of measure that is allowed to quantify a dual UOM controlled item.

ServiceLevel

string

The display name of a transportation priority that affects how quickly goods are transported. Applicable values are all meanings of the lookup Carrier Service Levels.

ServiceLevelCode

string

A code indicating the priority of transportation that affects how quickly goods are transported. Applicable values are all codes of the lookup Carrier Service Levels.

ShipToCustomer

string

The display name of a customer to whom materials, being procured in a drop ship or a back to back arrangement, need to be shipped.

ShipToCustomerContact

string

The display name of the customer contact to whom materials, being procured in a drop ship arrangement, need to be shipped.

ShipToCustomerContactId

long

The unique identifier for the customer contact to whom materials, being procured in a drop ship arrangement, need to be shipped.

ShipToCustomerId

long

The unique identifier of a customer to whom materials, being procured in a drop ship or a back to back arrangement need to be shipped.

ShipToCustomerLocation

string

The display name of a customer location where materials, being procured in a drop ship arrangement, need to be shipped.

ShipToCustomerLocationId

long

The unique identifier of a customer location where materials, being procured in a drop ship arrangement, need to be shipped.

ShipToExceptionAction

string

The display name of how to handle receipts when the receiving location differs from the ship-to location.

ShipToExceptionActionCode

string

A code indicating how to handle receipts when the receiving location differs from the ship-to location.

ShipToLocationCode

string

A code indicating a location where the supplier should ship the goods.

ShipToLocationId

long

The unique identifier of the location where the supplier should ship the goods.

ShipToOrganizationCode

string

A code indicating an inventory organization where the supplier should ship the goods.

ShipToOrganizationId

long

The unique identifier of the inventory organization where the supplier should ship the goods.

ShipToOrganizationName

string

The name of the inventory organization where the supplier should ship the goods.

SupplierOrderLine

string

The number or text that the supplier uses to identify a purchase order schedule.

TaxClassification

string

The display name of a group of taxes for reporting and processing purposes.

TaxClassificationCode

string

A code indicating a grouping of taxes for reporting and processing purposes.

TotalAmount

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

The sum of the ordered amount and the total tax amount.

TotalTaxAmount

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

The sum of the recoverable and non-recoverable tax amounts.

TransactionBusinessCategory

string

A business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

TransactionBusinessCategoryCode

string

A code indicating a business classification used by Oracle Fusion Tax to identify and categorize an external transaction into an Oracle Fusion Tax transaction.

UserDefinedFiscalClassification

string

A classification for any tax requirement that you cannot define using the existing fiscal classification types.

UserDefinedFiscalClassificationCode

string

A classification code for any tax requirement that you cannot define using the existing fiscal classification types.

WorkOrderId

long

Unique identifier for the contract manufacturing work order.

WorkOrderNumber

string

The display number used to identify the finished goods product of a contract manufacturing work order.

WorkOrderOperationId

long

The unique identifier of a work order operation.

WorkOrderOperationSequence

decimal

The display number used to identify the work order operation sequence.

WorkOrderSubTypeCode

string

A code indicating the work order operation subtype.

Purchase Request Service Version 1

Version 1 of a service allowing integrating applications to create, change, control, and get details about requisitions and purchase orders.

Life Cycle Status: Active

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseRequestService/}PurchaseRequestService

Service WSDL URL: https://servername/fscmService/PurchaseRequestService?WSDL

Relationships

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

Relationship Type Object or Service

Handles

Purchase Request Requisition Configuration Details Confirmation Service Data Object Version 1

Handles

Purchase Request Create Requisition Line Service Data Object Version 1

Handles

Purchase Request Requisition Distribution Confirmation Service Data Object Version 1

Handles

Purchase Request Get Confirmation Service Data Object Version 1

Handles

Purchase Request Change Documents Confirmation Service Data Object Version 1

Handles

Purchase Request Create Requisition Header Service Data Object Version 1

Handles

Purchase Request Control Documents Service Data Object Version 1

Handles

Purchase Request Create Requisition Distribution Service Data Object Version 1

Handles

Purchase Request Change Service Data Object Version 1

Handles

Purchase Request Create Requisition Configuration Details Service Data Object Version 1

Handles

Purchase Request Change Documents Service Data Object Version 1

Handles

Purchase Request Change Overall Confirmation Service Data Object Version 1

Handles

Purchase Request Change Document Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Control Document Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Requisition Header Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Requisition Configuration Detail Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Create Requisition Header Confirmation Service Data Object Version 1

Handles

Purchase Request Requisition Line Confirmation Service Data Object Version 1

Handles

Purchase Request Control Documents Confirmation Service Data Object Version 1

Handles

Purchase Request Requisition Line Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Get Service Data Object Version 1

Handles

Purchase Request Requisition Distribution Errors Confirmation Service Data Object Version 1

Handles

Purchase Request Control Actions Service Data Object Version 1

Handles

Purchase Request Control Overall Confirmation Service Data Object Version 1

Operations

getPurchaseRequest

An operation to get purchase request details.

Life Cycle Status: Active

Request Payload

Element Name Type Description

payload

Purchase Request Get Version 1

The input parameter structure for the operation.

Response Payload

Element Name Type Description

result

Purchase Request Get Confirmation Version 1

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

controlPurchaseRequest

An operation to perform a hold action on a requisition line, or to perform a hold or firm action on a purchase order schedule.

Life Cycle Status: Active

Request Payload

Element Name Type Description

payload

Purchase Request Control Actions Version 1

The input parameter structure for the operation.

Response Payload

Element Name Type Description

result

Purchase Request Control Overall Confirmation Version 1

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

changePurchaseRequest

An operation to change a purchase request. Depending on the current state, the operation may cancel a requisition line, cancel a change, or cancel or split a purchase order schedule.

Life Cycle Status: Active

Request Payload

Element Name Type Description

payload

Purchase Request Change Version 1

The input parameter structure for the operation.

Response Payload

Element Name Type Description

result

Purchase Request Change Overall Confirmation Version 1

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

submitImportRequisition

An operation to start the requisition import process, to complete the creation of the requisition with the data from the interface table. Calling applications should first load the interface table using the populateInterfaceTable operation, and then call the Purchase Request Web Service with the submitImportRequisition operation.

Life Cycle Status: Active

Request Payload

Element Name Type Description

interfaceSourceCode

string

A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV.

batchId

long

The unique identifier of a batch of records that can be provided during job submission, and used to match the requisition lines that are selected for processing.

requisitioningBUId

long

The unique identifier of a requisitioning business unit.

requisitioningBUName

string

The display name of a requisitioning business unit.

groupBy

string

A code indicating how the requisition lines are grouped when they are being processed by the import program. Requisition lines that are grouped together will be put on the same requisition header. Valid values include None, Buyer, Category, Item, Location, and Supplier.

nextRequisitionNumber

int

The display number used to identify the next requisition number to be created.

initiateApprovalAfterRequisitionImport

string

Indicates whether or not requisitions that are imported as incomplete will be submitted for approval right after the process completes.

maximumBatchSize

int

If this parameter is provided, the requisition lines will be processed in batches with a size not greater than the maximum batch size.

errorProcessingLevel

string

A code indicating whether processing should continue if an errors occurs. Valid values include All and Partial.

Response Payload

Element Name Type Description

result

Purchase Request Create Requisition Header Confirmation Version 1

The purchase request create operation, requisition header output information.

populateInterfaceTable

This operation is for when integrating applications have a high volume of supply requests, such as Planning, which may have thousands of requests for a single batch. The caller can call the Purchase Request Web Service with this operation multiple times to populate the interface table with the data to create requisitions. Once the interface table is fully loaded, the calling application must call the Purchase Request Web Service with the operation submit requisition import.

Life Cycle Status: Active

Request Payload

Element Name Type Description

interfaceSourceCode

string

A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV.

batchId

long

The unique identifier of a batch of records that can be provided during job submission, and used to match the requisition lines that are selected for processing.

purchaseRequestPayload

Purchase Request Create Requisition Header Version 1

The purchase request create operation, requisition header output information.

Response Payload

Element Name Type Description

result

string

For the populate interface table operation, the web service output payload will return either Success or Failure. In the case of Failure, the interface table will not be populated with the records sent in the input payload.

createRequisition

This operation combines populate interface table, and submit requisition import. It will write the attributes into the requisition interface tables, and then start the requisition import process to complete the creation of requisitions. The requisition import process will then perform the necessary derivation and validation logic on the requisition.

Life Cycle Status: Active

Request Payload

Element Name Type Description

interfaceSourceCode

string

A code indicating the outside source that the data was imported from. Reserved values for internal use include ORA_FUSION_DOO, ORA_FUSION_SCO, ORA_FUSION_INV.

requisitioningBUId

long

The unique identifier of a requisitioning business unit.

requisitioningBUName

string

The display name of a requisitioning business unit.

groupBy

string

A code indicating how the requisition lines are grouped when they are being processed by the import program. Requisition lines that are grouped together will be put on the same requisition header. Valid values include None, Buyer, Category, Item, Location, and Supplier.

nextRequisitionNumber

int

The display number used to identify the next requisition number to be created.

initiateApprovalAfterRequisitionImport

string

Indicates whether or not requisitions that are imported as incomplete will be submitted for approval right after the process completes.

maximumBatchSize

int

If this parameter is provided, the requisition lines will be processed in batches with a size not greater than the maximum batch size.

errorProcessingLevel

string

A code indicating whether processing should continue if an errors occurs. Valid values include All and Partial.

purchaseRequestPayload

Purchase Request Create Requisition Header Version 1

The purchase request create operation, requisition header output information.

Response Payload

Element Name Type Description

result

Purchase Request Create Requisition Header Confirmation Version 1

The purchase request create operation, requisition header output information.

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

populateInterfaceTable

PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Manage Purchase Request by Web Service

Allows management of purchase requests using web service.

submitImportRequisition

PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Manage Purchase Request by Web Service

Allows management of purchase requests using web service.

getPurchaseRequest

PO_SEARCH_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Search Purchase Request by Web Service

Allows searching for purchase requests using the web service.

controlPurchaseRequest

PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Manage Purchase Request by Web Service

Allows management of purchase requests using web service.

createRequisition

PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Manage Purchase Request by Web Service

Allows management of purchase requests using web service.

changePurchaseRequest

PO_MANAGE_PURCHASE_REQUEST_WEB_SERVICE_PRIV

Manage Purchase Request by Web Service

Allows management of purchase requests using web service.

Purchase Request Change Document Errors Confirmation Version 1

Version 1 of an object, representing the errors for each requisition or purchase order that are returned when the purchase request change operation is completed.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseRequestService/}PurchaseRequestChangeResultDetailError

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Request Change Documents Confirmation Version 1

Handled by

Purchase Request Service Version 1

Attributes

The following table describes attributes in the service data object.

Name Type Description

RequestStatusErrorAttribute

string

A text field indicating the attribute that received the error during processing.

RequestStatusErrorCode

string

A code indicating the error that occurred during processing.

RequestStatusErrorText

string

A text description capturing the error that occurred during processing.

Purchase Request Change Documents Confirmation Version 1

Version 1 of an object, representing the status of each requisition or purchase order that is returned when the purchase request change operation is completed.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseRequestService/}PurchaseRequestChangeResultDetail

Relationships

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

Attributes

The following table describes attributes in the service data object.

Name Type Description

BaseLineChangeOrderNumber

string

The display number used to identify a purchase order change order.

BaseLineChangeOrderSequence

long

The unique identifier of a purchase order change order.

IntegrationKey

string

A text field capturing a value that allows integrating applications to correlate their transaction with the Oracle Fusion Procurement transaction.

LineLocationId

long

The unique identifier of a purchase order schedule.

NewLineLocationId

long

The unique identifier of the new purchase order schedule that has been split.

NewScheduleNumber

decimal

The display number used to identify the new purchase order schedule that has been split.

PurchaseRequestChangeResultDetailError

Purchase Request Change Document Errors Confirmation Version 1

The errors for each requisition or purchase order that are returned when the purchase request change operation is completed.

RequestStatusCode

string

A code indicating the status of the requested change to a purchase order schedule or requisition line. Valid values include success, error, or failure.

RequisitionLineId

long

The unique identifier of a requisition line.

Purchase Request Change Documents Version 1

Version 1 of an object, representing the set of requisitions or purchase orders being changed, and the type of change being performed on each document.

QName: {http://xmlns.oracle.com/apps/prc/po/editDocument/purchaseRequestService/}PurchaseRequestChangeEntryDetail

Relationships

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

Relationship Type Object or Service

Contained by

Purchase Request Change Version 1

Handled by

Purchase Request Service Version 1

Attributes

The following table describes attributes in the service data object.

Name Type Description

AttachmentCategoryItem

string

Attachments of this category provide additional information about the item being ordered, and will be copied over from the source object to the purchase order line.

AttachmentCategoryShip

string

Attachments of this category provide additional information about the shipment being scheduled, like shipping or packing instructions, and will be copied over from the source object to the purchase order schedule.

BackToBackFlag

boolean

Indicates whether the purchase order schedule has a backing sales order that is fulfilled using a back to back order.

BaseLineChangeOrderSequence

long

The unique identifier of a purchase order change order.

Carrier

string

The display name of the company that transports goods from one point to another by land, sea, or air.

CarrierId

long

The unique identifier of the company that transports goods from one point to another by land, sea, or air.

ChangeActionCode

string

A code indicating the change action to be performed. Valid values include change, cancel, or split.

ChangeActionReason

string

A text description capturing the reason for the change.

CustomerItemDescription

string

A text description capturing a customer's identification number or code for the goods ordered on your order line.

CustomerItemNumber

string

The display name of a customer's identification number or code for the goods ordered on your order line.

CustomerPOLineNumber

string

The display number used to identify a purchase order line from the customer that originated the sales order, which is being fulfilled by the material being procured in a drop ship arrangement.

CustomerPONumber

string

The display number used to identify a purchase order from the customer that originated the sales order, which is being fulfilled by the material being procured in a drop ship arrangement.

CustomerPOScheduleNumber

string

The display number used to identify a purchase order schedule from the customer that originated the sales order, which is being fulfilled by the material being procured in a drop ship arrangement.

DaysEarlyReceiptAllowed

decimal

The maximum acceptable number of days early for receipts.

DaysLateReceiptAllowed

decimal

The maximum acceptable number of days late for receipts.

DeleteAllAttachmentsFlag

boolean

Indicates whether all attachments should be deleted without creating new attachments.

DeliverToCustomerContactEmail

string

The email for a customer contact to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerContactId

long

The unique identifier of a customer contact to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerContactName

string

The display name of a customer contact to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerContactNumber

string

The display number used to identify a customer contact to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerId

long

The unique identifier of a customer to which materials, being procured in a drop ship or back to back arrangement, need to be delivered.

DeliverToCustomerLocationCLLICode

string

The CLLI code for the customer location to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerLocationId

long

The unique identifier of a customer location to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerLocationOriginalSystemReference

string

The original system reference for the customer location to which materials, being procured in a drop ship arrangement, need to be delivered.

DeliverToCustomerName

string

The display name of a customer to which materials, being procured in a drop ship or back to back arrangement, need to be delivered.

DeliverToCustomerNumber

string

The display number used to identify a customer to which materials, being procured in a drop ship or a back to back arrangement, need to be delivered.

DeliverToLocationCode

string

A code indicating the final delivery location for goods previously received from a supplier.

DeliverToLocationId

long

The unique identifier of a final delivery location for goods previously received from a supplier.

DestinationSubinventory

string

The display name of a subinventory to which the requested item should be delivered.

DestinationType

string

The display name indicating if the item should be charged to an inventory or should be expensed.

DestinationTypeCode

string

A code indic