1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. List of Values
  4. Purchase Orders List of Values

Get all purchase orders

get

/fscmRestApi/resources/11.13.18.05/purchaseOrdersLOV

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • 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: Find a purchase order according to the purchase order identifier.
      Finder Variables:
      • POHeaderId; integer; Value that uniquely identifies a purchase order.
    • findByIntent: Find purchase orders according to the intent.
      Finder Variables:
      • Intent; string; Value that uniquely identifies the intent. Valid value is APUser.
      • SysEffectiveDate; object.
  • 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:
    • BillToBU; string; Business unit that processes supplier invoices for the purchase order.
    • Buyer; string; Person who is responsible for managing the purchase order.
    • OrderNumber; string; Number that uniquely identifies the purchase order in the sold-to legal entity.
    • POHeaderId; integer; Value that uniquely identifies the purchase order.
    • SoldToLegalEntity; string; Party who is financially responsible for purchases on the purchase order.
    • Status; string; Status of the purchase order relative to the purchase order life cycle.
    • StatusCode; string; Abbreviation that identifies the purchase order status in the order life cycle.
    • Supplier; string; Supplier who fulfills the item.
    • SupplierSite; string; Location that the supplier uses to purchase the item.
  • 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
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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 : purchaseOrdersLOV
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : purchaseOrdersLOV-item-response
Type: object
Show Source
  • Title: Organization
    Read Only: true
    Maximum Length: 240
    Business unit that processes supplier invoices for the purchase order.
  • Read Only: true
    Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Person who is responsible for managing the purchase order.
  • Read Only: true
    Value that uniquely identifies the buyer.
  • Title: Currency Name
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the purchase order.
  • Links
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Title: Payment Terms
    Read Only: true
    Maximum Length: 50
    Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
  • Read Only: true
    Value that uniquely identifies the payment terms.
  • Read Only: true
    Value that uniquely identifies the purchase order.
  • Title: Legal Entity Name
    Read Only: true
    Maximum Length: 240
    Party who is financially responsible for purchases on the purchase order.
  • Read Only: true
    Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the purchase order relative to the purchase order life cycle.
  • Title: Status
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the purchase order status in the order life cycle.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    Supplier who fulfills the item.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Site
    Read Only: true
    Maximum Length: 240
    Location that the supplier uses to purchase the item.
  • Read Only: true
    Value that uniquely identifies the supplier site.
Back to Top

Examples

This example describes how to get all work areas.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrdersLOV"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"OrderNumber": "1000018",
		"POHeaderId": 100000016515358,
		"Supplier": "Tall Manufacturing",
		"SupplierId": 147,
		"SupplierSite": "PALMER-CTR_HQ",
		"SupplierSiteId": 2544,
		"BillToBU": "Vision Services",
		"BillToBUId": 458,
		"Buyer": "Jones, Clare",
		"BuyerId": 100010026863783,
		"Currency": "US Dollar",
		"CurrencyCode": "USD",
		"SoldToLegalEntity": "Vision Services",
		"SoldToLegalEntityId": 458,
		"Description": "zBIA_Testcase_6.5_2_Data_Dist",
		"PaymentTerms": "45 Net (terms date + 45)",
		"PaymentTermsId": 10003,
		"Status": "Closed",
		"StatusCode": "CLOSED"
	}, {
		...
	}
}
Back to Top