Get one schedule
get
/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedulesForLandedCosts/{POLineLocationId}
Request
Path Parameters
-
POLineLocationId(required): integer(int64)
Value that uniquely identifies the purchase order schedule.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : purchaseOrderSchedulesForLandedCosts-item-response
Type:
Show Source
object
-
AssociatedCharges: string
Title:
Associated Charges
Read Only:true
Maximum Length:15
Contains one of the following values. With Charges: charges estimated for the purchase order. Without Charges: charges are not estimated for the purchase order. The default value is Without Charges. -
Buyer: string
Title:
Buyer
Read Only:true
Maximum Length:240
Buyer for the purchase order. -
BuyerId: integer
(int64)
Title:
Buyer ID
Read Only:true
Value that uniquely identifies the buyer for the purchase order. -
DeliveredToInventoryOrg: string
Title:
Delivered-to Inventory Organization Name
Read Only:true
Maximum Length:18
Name of the inventory organization to which the item is delivered. -
DeliveredToInventoryOrgId: integer
(int64)
Title:
Delivered-To Inventory Organization ID
Read Only:true
Value that uniquely identifies the inventory organization to which the item is delivered. -
DestinationType: string
Title:
Destination Type
Read Only:true
Maximum Length:80
Destination type on the purchase order. -
LandedCostPOScheduleId: integer
(int64)
Title:
Landed Cost PO Schedule ID
Read Only:true
Value that uniquely identifies the purchase order schedule for landed cost. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date)
Title:
Need-by Date
Read Only:true
Date on the purchase order by when the item needs to be delivered. -
OrderedQuantityInPrimaryUOM: number
Title:
Ordered Quantity
Read Only:true
Quantity on the purchase order schedule. -
POApprovalDate: string
(date)
Title:
PO Approval Date
Read Only:true
Date when the purchase order was approved. -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location ID
Read Only:true
Value that uniquely identifies the purchase order schedule. -
ProcurementBU: string
Title:
Procurement BU
Read Only:true
Maximum Length:240
Procurement business unit on the purchase order schedule. -
ProcurementBUId: integer
(int64)
Title:
Procurement Business Unit ID
Read Only:true
Value that uniquely identifies the procurement business unit for the material purchase order schedule. -
ProfitCenterBU: string
Title:
Profit Center BU
Read Only:true
Maximum Length:240
Profit center business unit on the purchase order schedule. -
ProfitCenterBUId: integer
(int64)
Title:
Profit Center BU ID
Read Only:true
Value that uniquely identifies profit center business unit for the material purchase order schedule. -
PromisedDate: string
(date)
Title:
Promised Date
Read Only:true
Date when the order was promised to be delivered. -
PurchaseOrderCurrency: string
Read Only:
true
Maximum Length:80
Name of the currency for the purchase order amount. -
PurchaseOrderCurrencyCode: string
Read Only:
true
Maximum Length:15
Code that identifies the currency for the purchase order amount. -
PurchaseOrderDescription: string
Title:
Purchase Order Description
Read Only:true
Maximum Length:240
Description on the purchase order. -
PurchaseOrderFunctionalCurrencyAmount: number
Title:
PO Schedule Functional Currency Amount
Read Only:true
Amount in the functional currency on the purchase order schedule line. -
PurchaseOrderHeaderId: integer
(int64)
Title:
Purchase Order Header ID
Read Only:true
Value that uniquely identifies purchase order header. -
PurchaseOrderItemNumber: string
Title:
Purchase Order Item Number
Read Only:true
Maximum Length:300
Item on the purchase order schedule. -
PurchaseOrderLineId: integer
(int64)
Title:
Purchase Order Line ID
Read Only:true
Value that uniquely identifies purchase order line. -
PurchaseOrderLineNumber: string
Title:
Purchase Order Line
Read Only:true
Maximum Length:40
Number that identifies the line in the purchase order. -
PurchaseOrderNumber: string
Title:
Purchase Order
Read Only:true
Maximum Length:255
Number that identifies the material purchase order for the landed cost estimate. -
PurchaseOrderScheduleNumber: string
Title:
Purchase Order Schedule Number
Read Only:true
Maximum Length:40
Schedule of the material purchase order line used for the landed cost estimate. -
RequisitioningBU: string
Title:
Requisitioning BU
Read Only:true
Maximum Length:240
Requisitioning business unit on the purchase order schedule. -
RequisitioningBUId: integer
(int64)
Title:
Requisitioning BU ID
Read Only:true
Value that uniquely identifies the requisitioning business unit for the material purchase order schedule. -
shipmentDetails: array
Shipment Details
Title:
Shipment Details
The Shipment Details resource gets the information of shipments associated with the purchase order schedule. -
ShipToLocation: string
Title:
Ship-to Location
Read Only:true
Maximum Length:30
Location to which the item is delivered. -
ShipToLocationId: integer
(int64)
Title:
Ship-To Location ID
Read Only:true
Value that uniquely identifies the location to which the item is delivered. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:360
Supplier on the purchase order. -
SupplierId: integer
(int64)
Title:
Supplier ID
Read Only:true
Value that uniquely identifies the supplier on the purchase order. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:15
Supplier site on the purchase order. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site ID
Read Only:true
Value that uniquely identifies the supplier site on the purchase order. -
TaxExclusivePOPrice: number
Title:
Tax Exclusive PO Price
Read Only:true
Tax exclusive item price on the purchase order. -
tradeOperationDetails: array
Trade Operation Details
Title:
Trade Operation Details
The Trade Operation Details resource gets the information of the trade operation charges created for the purchase order schedule. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:25
Unit of measure for the purchase order schedule quantity. -
UnitOfMeasureCode: string
Read Only:
true
Maximum Length:3
Code that identifies the unit of measure for the purchase order schedule quantity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Shipment Details
Type:
array
Title:
Shipment Details
The Shipment Details resource gets the information of shipments associated with the purchase order schedule.
Show Source
Nested Schema : Trade Operation Details
Type:
array
Title:
Trade Operation Details
The Trade Operation Details resource gets the information of the trade operation charges created for the purchase order schedule.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : purchaseOrderSchedulesForLandedCosts-shipmentDetails-item-response
Type:
Show Source
object
-
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item in a purchase order. -
ItemId: integer
(int64)
Title:
Item ID
Read Only:true
Value that uniquely identifies the item. -
LineNumber: integer
(int64)
Title:
Line Number
Read Only:true
Number that identifies the shipment line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POHeaderId: integer
(int64)
Title:
Purchase Order Header ID
Read Only:true
Value that uniquely identifies purchase order header. -
POLineId: integer
(int64)
Title:
Purchase Order Line ID
Read Only:true
Value that uniquely identifies purchase order line. -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location ID
Read Only:true
Value that uniquely identifies purchase order shipment schedule. -
QuantityReceived: number
Title:
Receipt Quantity
Read Only:true
Received quantity corresponding to the purchase order schedule. -
QuantityShipped: number
Title:
Shipped Quantity
Read Only:true
Shipped quantity corresponding to the purchase order schedule. -
ReceiptNumber: string
Title:
Receipt Number
Read Only:true
Maximum Length:30
Receipt number for the shipment. -
ShipmentHeaderId: integer
(int64)
Title:
Shipment Header ID
Read Only:true
Value that uniquely identifies the shipment header. -
ShipmentLineId: integer
(int64)
Title:
Shipment Line ID
Read Only:true
Value that uniquely identifies the shipment line. -
ShipmentNumber: string
Title:
Shipment Number
Read Only:true
Maximum Length:30
Number that identifies the shipment. -
ShippedDate: string
(date-time)
Title:
Shipped Date
Read Only:true
Date when the purchase order was shipped.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response
Type:
Show Source
object
-
ChargeLineNumber: number
Title:
Charge Line Number
Read Only:true
Number that identifies the trade operation charge line. -
ChargeLineStatus: string
Title:
Charge Line Status Meaning
Read Only:true
Maximum Length:80
Abbreviation that uniquely identifies the status of the charge line. Valid values include Allocated, Allocated with Warning, Allocation in Error, Cancelled, Draft Allocation, Incomplete, New, Pending Association, Ready for Allocation, and Requires Reallocation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Charge Name
Read Only:true
Maximum Length:80
Charge name for which the estimates and actual amounts are entered. -
RequiredBUCurrencyCode: string
Title:
Charge BU Functional Currency
Read Only:true
Maximum Length:15
Functional currency of the charge business unit. -
TotalActualAmount: number
Title:
Actual Amount
Read Only:true
Total actual amount incurred on the trade operation. -
TotalEstimatedAmount: number
Title:
Estimated Amount
Read Only:true
Total estimated amount incurred on the trade operation. -
TradeOperationId: integer
Title:
Trade Operation ID
Read Only:true
Value that uniquely identifies the trade operation. -
TradeOperationName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the trade operation to which the charge line belongs. -
TradeOperationNumber: string
Title:
Number
Read Only:true
Maximum Length:40
Number that identifies the trade operation to which the charge line belongs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- shipmentDetails
-
Parameters:
- POLineLocationId:
$request.path.POLineLocationId
The Shipment Details resource gets the information of shipments associated with the purchase order schedule. - POLineLocationId:
- tradeOperationDetails
-
Parameters:
- POLineLocationId:
$request.path.POLineLocationId
The Trade Operation Details resource gets the information of the trade operation charges created for the purchase order schedule. - POLineLocationId:
Examples
This example describes how to get one schedule.
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/purchaseOrderSchedulesForLandedCosts/POLineLocationId"
For example, the following command gets one schedule where the purchase order line location identifier is 300100088814877:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedulesForLandedCost/300100088814877"
Example Response Body
The following shows an example of the response body in JSON format.
{ "AssociatedCharges": "With Charges", "Buyer": "Furey,Clare", "BuyerId": 100010026863783, "LandedCostPOScheduleId": 84021, "DeliveredToInventoryOrg": "V1", "DeliveredToInventoryOrgId": 204, "DestinationType": "Inventory", "NeedByDate": "2020-12-31", "OrderedQuantityInPrimaryUOM": 6, "POApprovalDate": "2015-12-14", "POLineLocationId": 300100088814877, "ProcurementBU": "Vision Corporation", "ProcurementBUId": 204, "ProfitCenterBU": "Vision Corporation", "ProfitCenterBUId": 204, "PromisedDate": null, "PurchaseOrderDescription": "Crank Shaft", "PurchaseOrderFunctionalCurrencyAmount": 3000, "PurchaseOrderCurrency": "US Dollar", "PurchaseOrderCurrencyCode": "USD", "PurchaseOrderHeaderId": 300100088814874, "PurchaseOrderItemNumber": "CM-CRS-SD7", "PurchaseOrderLineNumber": "1", "PurchaseOrderLineId": 300100088814876, "PurchaseOrderNumber": "VOP1003796", "PurchaseOrderScheduleNumber": "1", "RequisitioningBU": "Vision Corporation", "RequisitioningBUId": 204, "ShipToLocation": "V1 Ship Site A", "ShipToLocationId": 20795, "Supplier": "ZOKC_PODEL_PARTYMERGE_SUPPLIER1", "SupplierId": 300100087618588, "SupplierSite": "ZOKCPODS3SITE3", "SupplierSiteId": 300100087618605, "TaxExclusivePOPrice": 3000, "UnitOfMeasure": "Each", "UnitOfMeasureCode": "Ea", "links": ... }