1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Purchase Order Schedules

Get all schedules

get

/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules

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 purchase order schedules according to the line location identifier as the primary key.
      Finder Variables:
      • LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
    • findPOSchedules: Find purchase order schedules according to the specified values.
      Finder Variables:
      • Intent; string; Value that uniquely identifies the intent. Valid values are APUser, POUser, LOBUser, SSPUser and NonAgentUser.
      • POHeaderId; integer; Value that uniquely identifies the purchase order.
      • ScheduleStatus; string; Status of the purchase order schedule.
      • 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:
    • AnticipatedArrivalDate; string; Date when the ordered goods are expected to be delivered based on the current projected date of shipping.
    • BilledAmount; number; Amount equivalent of the matched invoice lines based on the purchase price.
    • BilledQuantity; number; Quantity invoiced against the purchase order schedule.
    • Buyer; string; Person who is responsible for managing the purchase order.
    • BuyerId; integer; Value that uniquely identifies the buyer.
    • CreationDate; string; Date and time when the buyer or application created the purchase order schedule.
    • DocumentStatus; string; Status of the purchase order relative to the purchase order life cycle.
    • DocumentStyle; string; Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
    • FundsStatus; string; Status of the funds check or funds reservation validation result for the schedule.
    • InvoiceMatchOption; string; Value that determines whether to match the invoice to the purchase order or the receipt. If the purchase order line is under consignment, then match each invoice to the consumption advice.
    • LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
    • LineNumber; number; Number that uniquely identifies the purchase order line.
    • OrderNumber; string; Number that uniquely identifies the purchase order in the sold-to legal entity.
    • POHeaderId; integer; Value that uniquely identifies the purchase order.
    • ProcurementBU; string; Business unit that manages and owns the purchase order.
    • RequestedDeliveryDate; string; Date when the buyer requested that the supplier deliver the item.
    • RequisitioningBU; string; Business unit that creates the requisition.
    • ScheduleNumber; integer; Number that uniquely identifies the purchase order schedule for the purchase order line.
    • ScheduleStatus; string; Status of the purchase order schedule.
    • SoldToLegalEntity; string; Legal entity that is financially responsible for purchases on the purchase order.
    • Supplier; string; Name of the 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 : purchaseOrderSchedules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : purchaseOrderSchedules-item-response
Type: object
Show Source
  • Title: Accepted Amount
    Read Only: true
    Amount accepted for service lines.
  • Title: Accepted Quantity
    Read Only: true
    Quantity accepted after inspection.
  • Title: Accrue at Receipt
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then accrue the purchase order schedule upon receipt. If false, then do not accrue upon receipt.
  • Title: Ordered
    Read Only: true
    Amount for the service on the purchase order schedule.
  • Title: Anticipated Arrival Date
    Read Only: true
    Date when the ordered goods are expected to be delivered based on the current projected date of shipping.
  • Title: Invoiced Amount
    Read Only: true
    Amount equivalent of the matched invoice lines based on the purchase price.
  • Title: Invoiced Quantity
    Read Only: true
    Quantity invoiced against the purchase order schedule.
  • Title: Buyer
    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: Category Name
    Read Only: true
    Maximum Length: 2400
    Name of the purchasing category that the purchase order uses to classify the purchase for the order line.
  • Read Only: true
    Maximum Length: 820
    Abbreviation that identifies the purchasing category.
  • Read Only: true
    Value that uniquely identifies the purchasing category.
  • Title: Closed Reason
    Read Only: true
    Maximum Length: 240
    Text that describes the reason why the schedule was closed.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application created the purchase order schedule.
  • Title: Order Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order relative to the purchase order life cycle.
  • Title: Document Status Code
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the purchase order status in the order life cycle.
  • Title: Document Style
    Read Only: true
    Maximum Length: 240
    Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
  • Read Only: true
    Value that uniquely identifies the purchasing style of the document.
  • Title: Due Date
    Read Only: true
    Date when the goods are requested or promised to deliver.
  • Title: Freight Terms
    Read Only: true
    Maximum Length: 80
    Terms that describe who pays the charges to transport the item.
  • Title: Freight Terms Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of freight terms for the purchase order.
  • Title: Funds Status
    Read Only: true
    Maximum Length: 80
    Status of the funds check or funds reservation validation result for the schedule.
  • Title: Funds Status
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the funds status.
  • Title: Invoice Match Option
    Read Only: true
    Maximum Length: 80
    Value that determines whether to match the invoice to the purchase order or the receipt. If the purchase order line is under consignment, then match each invoice to the consumption advice.
  • Title: Invoice Match Option Code
    Read Only: true
    Maximum Length: 25
    Determines whether the invoice for the purchase order schedule must match the purchase order or the receipt. Values include C for consumption advice, P for order, or R for receipt.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the item that the purchase order references.
  • Read Only: true
    Value that uniquely identifies the item on the purchase order.
  • Title: Item
    Read Only: true
    Abbreviation that uniquely identifies the item on the purchase order.
  • Title: Description
    Read Only: true
    Maximum Length: 255
    Displays either the description of the item or of the work associated with a progress payment schedule.
  • Read Only: true
    Value that uniquely identifies the purchase order schedule.
  • Title: Line
    Read Only: true
    Number that uniquely identifies the purchase order line.
  • Title: Line - Schedule
    Read Only: true
    Maximum Length: 255
    Concatenation of the PO line number and the schedule number.
  • 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.
  • Read Only: true
    Value that uniquely identifies the parent line of the schedule. This attribute is used when the schedule is split.
  • Title: Price
    Read Only: true
    Price of the purchase order line.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Business unit that manages and owns the purchase order.
  • Read Only: true
    Value that uniquely identifies the business unit that manages and owns the purchase order.
  • Title: Purchase Basis
    Read Only: true
    Maximum Length: 80
    Value that indicates whether the schedule is for goods or services.
  • Title: Purchase Basis Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that indicates if the schedule is for quantity based purchases or fixed price services.
  • Title: Quantity
    Read Only: true
    Quantity of the item scheduled to be shipped or delivered.
  • Title: Received Amount
    Read Only: true
    Amount received for service lines.
  • Title: Received Quantity
    Read Only: true
    Quantity received against the purchase order schedule.
  • Title: Requested Delivery Date
    Read Only: true
    Date when the buyer requested that the supplier deliver the item.
  • Title: Requested Ship Date
    Read Only: true
    Date when the buyer requested that the supplier ship the item.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Business unit that creates the requisition.
  • Read Only: true
    Value that uniquely identifies the business unit that creates the requisition.
  • Title: Retainage
    Read Only: true
    Total amount withheld as retainage against the schedule.
  • Title: Retainage Rate
    Read Only: true
    Percentage of the invoice value that can be withheld as retainage.
  • Title: Retainage Released
    Read Only: true
    Amount of retainage released for the schedule.
  • Title: Schedule Description
    Read Only: true
    Maximum Length: 240
    Description of the work associated with a progress payment schedule.
  • Title: Schedule
    Read Only: true
    Number that uniquely identifies the purchase order schedule for the purchase order line.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order schedule.
  • Title: Status Code
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the status of the purchase order schedule.
  • Title: Schedule Type
    Read Only: true
    Maximum Length: 80
    Value that identifies whether the payment is released based on units of work or lump sum.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the schedule type.
  • Title: Shipped Amount
    Read Only: true
    Amount shipped for service lines.
  • Title: Shipped Quantity
    Read Only: true
    Quantity shipped against the purchase order schedule.
  • Title: Ship-to Party
    Read Only: true
    Maximum Length: 360
    Name of the party who receives the item that the supplier ships.
  • Read Only: true
    Value that uniquely identifies the third party that receives the item.
  • Title: Ship-to Location
    Read Only: true
    Maximum Length: 240
    Name of the location where the supplier ships the item.
  • Title: Ship-to Location Code
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the location where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the location where the supplier ships the item.
  • Title: Sold-to Legal Entity
    Read Only: true
    Maximum Length: 240
    Legal entity that 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: Supplier
    Read Only: true
    Maximum Length: 360
    Name of the supplier who fulfills the item.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 300
    Number that the supplier uses to identify the item on the purchase order line.
  • Title: Supplier 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.
  • Title: Total
    Read Only: true
    Total of the ordered amount and the exclusive tax amounts on the purchase order line.
  • Title: Total Tax
    Read Only: true
    Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order line.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Unit of measure in the item quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
Back to Top

Examples

This example describes how to get all schedules.

Example Description
Example 1 Gets all schedules across multiple orders
Example 2 Get all schedules for all the lines in an order
Example 3 Get a specific schedule for a line in an order
Example 4 Get all schedules that are finally closed

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource to get all schedules across multiple orders:

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

Example 1 Response Body

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

{
	"items": [
	{
		"SoldToLegalEntityId": 1036,
		"POHeaderId": 300100182700591,
		"OrderNumber": "80",
		"BuyerId": 100010026863783,
		"POLineId": 300100182700592,
		"ItemDescription": "Drop Ship Item 01 for DS as Seller flow",
		"ItemId": 300100182698836,
		"Price": 100,
		"LineNumber": 1,
		"UOMCode": "Ea",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 300100182700593,
		"ScheduleNumber": 1,
		"ShipToLocationId": null,
		"RequestedDeliveryDate": "2019-09-06T00:00:00+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "P",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": null,
		"AcceptedAmount": null,
		"ShipToCustomerId": 300100059769352,
		"SoldToLegalEntity": "Vision Brazil",
		"UOM": "Each",
		"ShipToLocationCode": null,
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10001,
		"FreightTermsCode": "Due",
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Furey,Clare",
		"InvoiceMatchOption": "Order",
		"PaymentTerms": "Immediate",
		"FreightTerms": "Due",
		"ShipToCustomer": "BR Fusion S.A.",
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": "BRDS01",
		"Total": 1000,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 10,
		"Amount": 1000,
		"ShipToLocation": null,
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2019-09-06T20:45:39+00:00",
		"RequestedShipDate": null,
		"Supplier": "Brazil DS Ltda.",
		"SupplierId": 300100182014594,
		"SupplierSiteId": 300100182014808,
		"SupplierSite": "MAIN",
		"RetainageRate": null,
		"Retainage": null,
		"RetainageReleased": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100182700593",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100182700593",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100182700593/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	},
	{
		"SoldToLegalEntityId": 1036,
		"POHeaderId": 300100127172094,
		"OrderNumber": "57",
		"BuyerId": 100010026863783,
		"POLineId": 300100127172096,
		"ItemDescription": "AS88871 - Lot Item",
		"ItemId": 300100127166055,
		"Price": 80,
		"LineNumber": 1,
		"UOMCode": "Ea",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 300100127172097,
		"ScheduleNumber": 1,
		"ShipToLocationId": null,
		"RequestedDeliveryDate": "2018-01-16T00:00:00+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "P",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": null,
		"AcceptedAmount": null,
		"ShipToCustomerId": 300100127998527,
		"SoldToLegalEntity": "Vision Brazil",
		"UOM": "Each",
		"ShipToLocationCode": null,
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10134,
		"FreightTermsCode": "Due",
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Furey,Clare",
		"InvoiceMatchOption": "Order",
		"PaymentTerms": "Net 30",
		"FreightTerms": "Due",
		"ShipToCustomer": "Brazil_Customer1",
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": "AS88871",
		"Total": 8000,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100,
		"Amount": 8000,
		"ShipToLocation": null,
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2018-01-16T13:19:31+00:00",
		"RequestedShipDate": null,
		"Supplier": "Marcopolo",
		"SupplierId": 300100093494034,
		"SupplierSiteId": 300100093494050,
		"SupplierSite": "Rio Branco",
		"RetainageRate": null,
		"Retainage": null,
		"RetainageReleased": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100127172097",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100127172097",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100127172097/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	}
	],
	"count": 2,
	"hasMore": true,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules",
		"name": "purchaseOrderSchedules",
		"kind": "collection"
	}
	]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource to get all schedules for all the lines in an order:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules?q=OrderNumber='68'"

Example 2 Response Body

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

{
	"items": [
	{
		"SoldToLegalEntityId": 1036,
		"POHeaderId": 300100151188247,
		"OrderNumber": "68",
		"BuyerId": 100010026863783,
		"POLineId": 300100151188249,
		"ItemDescription": "Brazil Cement",
		"ItemId": 300100068025061,
		"Price": 100,
		"LineNumber": 1,
		"UOMCode": "BOX",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 300100151188250,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100060012091,
		"RequestedDeliveryDate": "2018-04-20T00:00:00+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "C",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 7,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": 0,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision Operations",
		"UOM": "BOX",
		"ShipToLocationCode": "Vision Operations Sao Paulo Site 1",
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10134,
		"FreightTermsCode": "Due",
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Furey,Clare",
		"InvoiceMatchOption": "Consumption Advice",
		"PaymentTerms": "Net 30",
		"FreightTerms": "Due",
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": "BR01",
		"Total": 10000000,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100000,
		"Amount": 10000000,
		"ShipToLocation": "Vision Operations Sao Paulo Site 1",
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2018-04-20T09:34:32+00:00",
		"RequestedShipDate": null,
		"Supplier": "Jones",
		"SupplierId": 300100093494034,
		"SupplierSiteId": 300100093494050,
		"SupplierSite": "Rio Branco",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	},
	{
		"SoldToLegalEntityId": 1036,
		"POHeaderId": 300100151188247,
		"OrderNumber": "68",
		"BuyerId": 100010026863783,
		"POLineId": 300100151188252,
		"ItemDescription": "Brazil Purchased Item 02",
		"ItemId": 300100068025063,
		"Price": 110,
		"LineNumber": 2,
		"UOMCode": "BOX",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 300100151188253,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100060012091,
		"RequestedDeliveryDate": "2018-04-20T00:00:00+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "C",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": null,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision Operations",
		"UOM": "BOX",
		"ShipToLocationCode": "Vision Operations Sao Paulo Site 1",
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10134,
		"FreightTermsCode": "Due",
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Furey,Clare",
		"InvoiceMatchOption": "Consumption Advice",
		"PaymentTerms": "Net 30",
		"FreightTerms": "Due",
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": "BR02",
		"Total": 11000000,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100000,
		"Amount": 11000000,
		"ShipToLocation": "Vision Operations Sao Paulo Site 1",
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2018-04-20T09:34:32+00:00",
		"RequestedShipDate": null,
		"Supplier": "Jones",
		"SupplierId": 300100093494034,
		"SupplierSiteId": 300100093494050,
		"SupplierSite": "Rio Branco",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188253",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188253",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188253/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	},
	{
		"SoldToLegalEntityId": 300100014516903,
		"POHeaderId": 426036,
		"OrderNumber": "68",
		"BuyerId": 300100024668707,
		"POLineId": 385191,
		"ItemDescription": "Std",
		"ItemId": null,
		"Price": 100.25,
		"LineNumber": 1,
		"UOMCode": "Ea",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 368264,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100014484337,
		"RequestedDeliveryDate": "2015-12-03T13:53:20+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "P",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": null,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision City LE",
		"UOM": "Each",
		"ShipToLocationCode": "VC - Vision City",
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10001,
		"FreightTermsCode": null,
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Jones, Clare",
		"InvoiceMatchOption": "Order",
		"PaymentTerms": "Immediate",
		"FreightTerms": null,
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": null,
		"Total": 10025.00,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100,
		"Amount": 10025.00,
		"ShipToLocation": "VC - Vision City",
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2015-12-03T13:53:21+00:00",
		"RequestedShipDate": null,
		"Supplier": "Green Corp.",
		"SupplierId": 300100016486100,
		"SupplierSiteId": 300100016486125,
		"SupplierSite": "San Jose",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	}
	],
	"count": 3,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules",
		"name": "purchaseOrderSchedules",
		"kind": "collection"
	}
	]
}

Example 3 cURL Command

Use the following cURL command to submit a request on the REST resource to get a specific schedule for a line in an order:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules?q=OrderNumber='68';LineNumber=1;ScheduleNumber=1"

Example 3 Response Body

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

{
	"items": [
	{
		"SoldToLegalEntityId": 1036,
		"POHeaderId": 300100151188247,
		"OrderNumber": "68",
		"BuyerId": 100010026863783,
		"POLineId": 300100151188249,
		"ItemDescription": "Brazil Cement",
		"ItemId": 300100068025061,
		"Price": 100,
		"LineNumber": 1,
		"UOMCode": "BOX",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 300100151188250,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100060012091,
		"RequestedDeliveryDate": "2018-04-20T00:00:00+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "C",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 7,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": 0,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision Brazil",
		"UOM": "BOX",
		"ShipToLocationCode": "Vision Brazil Sao Paulo Site 1",
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10134,
		"FreightTermsCode": "Due",
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Jones, Clare",
		"InvoiceMatchOption": "Consumption Advice",
		"PaymentTerms": "Net 30",
		"FreightTerms": "Due",
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": "BR01",
		"Total": 10000000,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100000,
		"Amount": 10000000,
		"ShipToLocation": "Vision Brazil Sao Paulo Site 1",
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2018-04-20T09:34:32+00:00",
		"RequestedShipDate": null,
		"Supplier": "Marcopolo",
		"SupplierId": 300100093494034,
		"SupplierSiteId": 300100093494050,
		"SupplierSite": "Rio Branco",
		"RetainageRate": null,
		"Retainage": null,
		"RetainageReleased": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100151188250/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	},
	{
		"SoldToLegalEntityId": 300100014516903,
		"POHeaderId": 426036,
		"OrderNumber": "68",
		"BuyerId": 300100024668707,
		"POLineId": 385191,
		"ItemDescription": "Std",
		"ItemId": null,
		"Price": 100.25,
		"LineNumber": 1,
		"UOMCode": "Ea",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 368264,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100014484337,
		"RequestedDeliveryDate": "2015-12-03T13:53:20+00:00",
		"ScheduleStatusCode": "OPEN",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "P",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": null,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision City LE",
		"UOM": "Each",
		"ShipToLocationCode": "VC - Vision City",
		"ScheduleStatus": "Open",
		"PaymentTermsId": 10001,
		"FreightTermsCode": null,
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Jones, Clare",
		"InvoiceMatchOption": "Order",
		"PaymentTerms": "Immediate",
		"FreightTerms": null,
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": null,
		"Total": 10025.00,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 100,
		"Amount": 10025.00,
		"ShipToLocation": "VC - Vision City",
		"DocumentStatusCode": "OPEN",
		"DocumentStatus": "Open",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2015-12-03T13:53:21+00:00",
		"RequestedShipDate": null,
		"Supplier": "Office Depot",
		"SupplierId": 300100016486100,
		"SupplierSiteId": 300100016486125,
		"SupplierSite": "San Jose",
		"RetainageRate": null,
		"Retainage": null,
		"RetainageReleased": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/368264/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules",
		"name": "purchaseOrderSchedules",
		"kind": "collection"
	}
	]
}

Example 4 cURL Command

Use the following cURL command to submit a request on the REST resource to get all schedules that are finally closed:

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules?q=ScheduleStatus='Finally+Closed'"

Example 4 Response Body

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

{
	"items": [
	{
		"SoldToLegalEntityId": 300100014516903,
		"POHeaderId": 424995,
		"OrderNumber": "28",
		"BuyerId": 300100024668707,
		"POLineId": 383851,
		"ItemDescription": "POw/oItem",
		"ItemId": null,
		"Price": 10,
		"LineNumber": 2,
		"UOMCode": "Ea",
		"SupplierItem": null,
		"CategoryId": 1,
		"LineLocationId": 367444,
		"ScheduleNumber": 1,
		"ShipToLocationId": 300100014484337,
		"RequestedDeliveryDate": null,
		"ScheduleStatusCode": "FINALLY CLOSED",
		"ClosedReason": null,
		"InvoiceMatchOptionCode": "P",
		"BilledQuantity": 0,
		"ShippedQuantity": 0,
		"ReceivedQuantity": 0.5,
		"AcceptedQuantity": 0,
		"BilledAmount": null,
		"ShippedAmount": null,
		"ReceivedAmount": 0,
		"AcceptedAmount": null,
		"ShipToCustomerId": null,
		"SoldToLegalEntity": "Vision City LE",
		"UOM": "Each",
		"ShipToLocationCode": "VC - Vision City",
		"ScheduleStatus": "Finally Closed",
		"PaymentTermsId": 10001,
		"FreightTermsCode": null,
		"Category": "Miscellaneous_1",
		"CategoryCode": "MISC.MISC",
		"Buyer": "Jones, Clare",
		"InvoiceMatchOption": "Order",
		"PaymentTerms": "Immediate",
		"FreightTerms": null,
		"ShipToCustomer": null,
		"PurchaseBasisCode": "GOODS",
		"ItemNumber": null,
		"Total": 10,
		"TotalTax": 0,
		"PurchaseBasis": "Quantity",
		"Quantity": 1,
		"Amount": 10,
		"ShipToLocation": "VC - Vision City",
		"DocumentStatusCode": "FINALLY CLOSED",
		"DocumentStatus": "Finally Closed",
		"AnticipatedArrivalDate": null,
		"CreationDate": "2014-08-07T15:22:57+00:00",
		"RequestedShipDate": null,
		"Supplier": "Office Depot",
		"SupplierId": 300100016486100,
		"SupplierSiteId": 300100016486125,
		"SupplierSite": "San Jose",
		"RetainageRate": null,
		"Retainage": null,
		"RetainageReleased": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/367444",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/367444",
			"name": "purchaseOrderSchedules",
			"kind": "item"
		},
		{
			"rel": "action",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/367444/action/close",
			"name": "close",
			"kind": "other"
		}
		]
	}
	],
	"count": 1,
"hasMore": true,
"limit": 25,
"offset": 0,
"links": [
	{
	"rel": "self",
	"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules",
	"name": "purchaseOrderSchedules",
	"kind": "collection"
}
]
}
Back to Top