1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. External Purchase Prices

Get all external purchase prices

get

/fscmRestApi/resources/11.13.18.05/externalPurchasePrices

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds external purchase prices according to the primary key.
      Finder Variables
      • HeaderId; integer; Value that uniquely identifies the external purchase prices.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ApprovalStatus; string; Status of the external purchase prices.
    • ApprovalStatusCode; string; Abbreviation that identifies status of the external purchase prices.
    • CurrencyCode; string; Abbreviation that identifies the currency of the external purchase prices.
    • EndDate; string; Date when the external purchase prices becomes ineffective.
    • ExpiredFlag; boolean; Contains one of the following values: true or false. If true, then the external purchase price is expired. If false, then the external purchase price is active. The default value is false.
    • ExternalPurchasePricesNumber; integer; Number that uniquely identifies the external purchase prices.
    • HeaderId; integer; Value that uniquely identifies the external purchase prices.
    • LastUpdateDate; string; Date and time when the user most recently updated the external purchase prices record.
    • ManufacturerName; string; Name of the manufacturer.
    • ObjectVersionNumber; integer; Number of times the external purchase prices has been updated.
    • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
    • ProcurementBUName; string; Name of the procurement business unit.
    • RequisitioningBUGroupId; integer; Value that uniquely identifies a group of requisitioning business units.
    • RequisitioningBUName; string; Name of the requisitioning business unit.
    • Source; string; Name of the person or organization in the source contract.
    • SourceContractDescription; string; Description of the source contract.
    • SourceContractNumber; string; Number that uniquely identifies the source contract.
    • SourceContractType; string; Type of the source contract.
    • SourceContractTypeCode; string; Abbreviation that identifies the type of the source contract.
    • SourceReferenceId; string; Value that uniquely identifies the external purchase prices in the source application.
    • SourceType; string; Type of the source contract.
    • StartDate; string; Date when the external purchase prices becomes effective.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierName; string; Name of the supplier.
    • SupplierNumber; string; Number that uniquely identifies the supplier.
    • SupplierSite; string; Name of the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • TierDescription; string; Description of the tier to which the source organization belongs.
    • TierLevel; integer; Number that indicates the tier to which the source organization belongs.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : externalPurchasePrices
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : externalPurchasePrices-item-response
Type: object
Show Source
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages the external purchase price lines.
Show Source
Nested Schema : externalPurchasePrices-lines-item-response
Type: object
Show Source
  • Read Only: true
    Value of the unit price after adjustment.
  • Read Only: true
    Percent value by which the base price is adjusted.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false.
  • Read Only: true
    Value that uniquely identifies the external purchase prices.
  • Read Only: true
    Maximum Length: 240
    Description of the item.
  • Read Only: true
    Maximum Length: 300
    Number that uniquely identifies the item.
  • Read Only: true
    Date and time when the user most recently updated the external purchase price line record.
  • Read Only: true
    Value that uniquely identifies the external purchase price line.
  • Number that uniquely identifies the external purchase price line.
  • Read Only: true
    Date when the price becomes ineffective.
  • Read Only: true
    Date when the price becomes effective.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the external purchase price line.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies status of the external purchase price line.
  • Links
  • Read Only: true
    Maximum Length: 700
    Number that uniquely identifies the manufacturer part.
  • Number of times the external purchase price line has been updated.
  • Read Only: true
    Value of the unit price before adjustment.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then a purchase agreement line is created for the line. If false, then a purchase agreement line isn't created for the line. The default value is false.
  • Read Only: true
    Maximum Length: 255
    Number that uniquely identifies the purchase agreement.
  • Read Only: true
    Value that uniquely identifies the purchasing category.
  • Read Only: true
    Maximum Length: 2400
    Name of the purchasing category.
  • Maximum Length: 1
    Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true.
  • Read Only: true
    Maximum Length: 300
    Number that uniquely identifies the supplier part.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then an unprocessed update exists for the line. If false, then there are no unprocessed updates for the line. The default value is false.
  • Maximum Length: 1
    Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the line is validated by the Import Purchase Agreements from External Purchase Prices process. If false, then the line isn't validated. The default value is true.
Links
updateLineStatus
Updates the status of the lines in an external purchase price or a change order.
Back to Top