Get one schedule
get
/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedulesForLandedCosts/{POLineLocationId}
Request
Path Parameters
-
POLineLocationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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: string
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: string
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 ChargesRead Only:trueMaximum Length:15 -
Buyer: string
Title:
BuyerRead Only:trueMaximum Length:240 -
BuyerId: integer
(int64)
Title:
Buyer IDRead Only:true -
DeliveredToInventoryOrg: string
Title:
Delivered-to Inventory Organization NameRead Only:trueMaximum Length:18 -
DeliveredToInventoryOrgId: integer
(int64)
Title:
Delivered-To Inventory Organization IDRead Only:true -
DestinationType: string
Title:
Destination TypeRead Only:trueMaximum Length:80 -
ExtendedPrecision: integer
(int32)
Read Only:
true -
IsChargeAssociated: string
Title:
Associated ChargesRead Only:trueMaximum Length:80 -
LandedCostPOScheduleId: integer
(int64)
Title:
Landed Cost PO Schedule IDRead Only:true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NeedByDate: string
(date)
Title:
Need-by DateRead Only:true -
OrderedQuantityInPrimaryUOM: number
Title:
Ordered QuantityRead Only:true -
POApprovalDate: string
(date)
Title:
PO Approval DateRead Only:true -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location IDRead Only:true -
Precision: integer
(int32)
Read Only:
true -
ProcurementBU: string
Title:
Procurement BURead Only:trueMaximum Length:240 -
ProcurementBUId: integer
(int64)
Title:
Procurement Business Unit IDRead Only:true -
ProfitCenterBU: string
Title:
Profit Center BURead Only:trueMaximum Length:240 -
ProfitCenterBUId: integer
(int64)
Title:
Profit Center BU IDRead Only:true -
PromisedDate: string
(date)
Title:
Promised DateRead Only:true -
PurchaseOrderCurrency: string
Read Only:
trueMaximum Length:80 -
PurchaseOrderCurrencyCode: string
Read Only:
trueMaximum Length:15 -
PurchaseOrderDescription: string
Title:
Purchase Order DescriptionRead Only:trueMaximum Length:240 -
PurchaseOrderFunctionalCurrencyAmount: number
Title:
PO Schedule Functional Currency AmountRead Only:true -
PurchaseOrderHeaderId: integer
(int64)
Title:
Purchase Order Header IDRead Only:true -
PurchaseOrderItemNumber: string
Title:
Purchase Order Item NumberRead Only:trueMaximum Length:300 -
PurchaseOrderLineId: integer
(int64)
Title:
Purchase Order Line IDRead Only:true -
PurchaseOrderLineNumber: string
Title:
Purchase Order LineRead Only:trueMaximum Length:40 -
PurchaseOrderNumber: string
Title:
Purchase OrderRead Only:trueMaximum Length:255 -
PurchaseOrderScheduleNumber: string
Title:
Purchase Order Schedule NumberRead Only:trueMaximum Length:40 -
RequisitioningBU: string
Title:
Requisitioning BURead Only:trueMaximum Length:240 -
RequisitioningBUId: integer
(int64)
Title:
Requisitioning BU IDRead Only:true -
shipmentDetails: array
shipmentDetails
-
ShipToLocation: string
Title:
Ship-to LocationRead Only:trueMaximum Length:30 -
ShipToLocationId: integer
(int64)
Title:
Ship-To Location IDRead Only:true -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:360 -
SupplierId: integer
(int64)
Title:
Supplier IDRead Only:true -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:15 -
SupplierSiteId: integer
(int64)
Title:
Supplier Site IDRead Only:true -
TaxExclusivePOPrice: number
Title:
Tax Exclusive PO PriceRead Only:true -
tradeOperationDetails: array
tradeOperationDetails
-
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:25 -
UnitOfMeasureCode: string
Read Only:
trueMaximum Length:3
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 DescriptionRead Only:trueMaximum Length:240 -
ItemId: integer
(int64)
Title:
Item IDRead Only:true -
LineNumber: integer
(int64)
Title:
Line NumberRead Only:true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
POHeaderId: integer
(int64)
Title:
Purchase Order Header IDRead Only:true -
POLineId: integer
(int64)
Title:
Purchase Order Line IDRead Only:true -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location IDRead Only:true -
QuantityReceived: number
Title:
Receipt QuantityRead Only:true -
QuantityShipped: number
Title:
Shipped QuantityRead Only:true -
ReceiptNumber: string
Title:
Receipt NumberRead Only:trueMaximum Length:30 -
ShipmentHeaderId: integer
(int64)
Title:
Shipment Header IDRead Only:true -
ShipmentLineId: integer
(int64)
Title:
Shipment Line IDRead Only:true -
ShipmentNumber: string
Title:
Shipment NumberRead Only:trueMaximum Length:30 -
ShippedDate: string
(date-time)
Title:
Shipped DateRead Only:true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response
Type:
Show Source
object-
ChargeLineNumber: number
Title:
Charge Line NumberRead Only:true -
ChargeLineStatus: string
Title:
Charge Line Status MeaningRead Only:trueMaximum Length:80 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
Charge NameRead Only:trueMaximum Length:80 -
RequiredBUCurrencyCode: string
Title:
Charge BU Functional CurrencyRead Only:trueMaximum Length:15 -
TotalActualAmount: number
Title:
Actual AmountRead Only:true -
TotalEstimatedAmount: number
Title:
Estimated AmountRead Only:true -
TradeOperationId: integer
Title:
Trade Operation IDRead Only:true -
TradeOperationName: string
Title:
NameRead Only:trueMaximum Length:80 -
TradeOperationNumber: string
Title:
NumberRead Only:trueMaximum Length:40
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- shipmentDetails
-
Parameters:
- POLineLocationId:
$request.path.POLineLocationId
- POLineLocationId:
- tradeOperationDetails
-
Parameters:
- POLineLocationId:
$request.path.POLineLocationId
- 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":
...
}