Jump to

• Request
• Response
• Examples

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: 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 Top

Response

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.

Body ()

Root Schema : purchaseOrderSchedulesForLandedCosts-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "title":"Requisitioning BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit for the material purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure for the purchase order schedule quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "tradeOperationDetails":{
            "title":"Trade Operation Details",
            "type":"array",
            "description":"The Trade Operation Details resource gets the information of the trade operation charges created for the purchase order schedule.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response"
            }
        },
        "TaxExclusivePOPrice":{
            "title":"Tax Exclusive PO Price",
            "type":"number",
            "description":"Tax exclusive item price on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveredToInventoryOrgId":{
            "title":"Delivered-To Inventory Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization to which the item is delivered.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":240,
            "type":"string",
            "description":"Buyer for the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PurchaseOrderFunctionalCurrencyAmount":{
            "title":"PO Schedule Functional Currency Amount",
            "type":"number",
            "description":"Amount in the functional currency on the purchase order schedule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "title":"Purchase Order Line Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DestinationType":{
            "title":"Destination Type",
            "maxLength":80,
            "type":"string",
            "description":"Destination type on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PromisedDate":{
            "title":"Promised Date",
            "type":"string",
            "description":"Date when the order was promised to be delivered.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderHeaderId":{
            "title":"Purchase Order Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfitCenterBUId":{
            "title":"Profit Center BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies profit center business unit for the material purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuyerId":{
            "title":"Buyer ID",
            "type":"integer",
            "description":"Value that uniquely identifies the buyer for the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":240,
            "type":"string",
            "description":"Requisitioning business unit on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site on the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProfitCenterBU":{
            "title":"Profit Center BU",
            "maxLength":240,
            "type":"string",
            "description":"Profit center business unit on the purchase order schedule.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PurchaseOrderItemNumber":{
            "title":"Purchase Order Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Item on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"Supplier on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PurchaseOrderScheduleNumber":{
            "title":"Purchase Order Schedule Number",
            "maxLength":40,
            "type":"string",
            "description":"Schedule of the material purchase order line used for the landed cost estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderLineNumber":{
            "title":"Purchase Order Line",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the line in the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderLineId":{
            "title":"Purchase Order Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies purchase order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":240,
            "type":"string",
            "description":"Procurement business unit on the purchase order schedule.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement Business Unit ID",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit for the material purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PurchaseOrderCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency for the purchase order amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PurchaseOrderNumber":{
            "title":"Purchase Order",
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the material purchase order for the landed cost estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "title":"Ship-To Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the location to which the item is delivered.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the purchase order schedule quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LandedCostPOScheduleId":{
            "title":"Landed Cost PO Schedule ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule for landed cost.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DeliveredToInventoryOrg":{
            "title":"Delivered-to Inventory Organization Name",
            "maxLength":18,
            "type":"string",
            "description":"Name of the inventory organization to which the item is delivered.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssociatedCharges":{
            "title":"Associated Charges",
            "maxLength":15,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "POApprovalDate":{
            "title":"PO Approval Date",
            "type":"string",
            "description":"Date when the purchase order was approved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseOrderDescription":{
            "title":"Purchase Order Description",
            "maxLength":240,
            "type":"string",
            "description":"Description on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":30,
            "type":"string",
            "description":"Location to which the item is delivered.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier on the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderedQuantityInPrimaryUOM":{
            "title":"Ordered Quantity",
            "type":"number",
            "description":"Quantity on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "shipmentDetails":{
            "title":"Shipment Details",
            "type":"array",
            "description":"The Shipment Details resource gets the information of shipments associated with the purchase order schedule.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderSchedulesForLandedCosts-shipmentDetails-item-response"
            }
        },
        "NeedByDate":{
            "title":"Need-by Date",
            "type":"string",
            "description":"Date on the purchase order by when the item needs to be delivered.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":15,
            "type":"string",
            "description":"Supplier site on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PurchaseOrderCurrency":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the currency for the purchase order amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object purchaseOrderSchedulesForLandedCosts-shipmentDetails-item-response

{
    "title":"Shipment Details",
    "type":"array",
    "description":"The Shipment Details resource gets the information of shipments associated with the purchase order schedule.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderSchedulesForLandedCosts-shipmentDetails-item-response"
    }
}

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

• Array of: object purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response

{
    "title":"Trade Operation Details",
    "type":"array",
    "description":"The Trade Operation Details resource gets the information of the trade operation charges created for the purchase order schedule.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : purchaseOrderSchedulesForLandedCosts-shipmentDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "QuantityShipped":{
            "title":"Shipped Quantity",
            "type":"number",
            "description":"Shipped quantity corresponding to the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentNumber":{
            "title":"Shipment Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ShippedDate":{
            "title":"Shipped Date",
            "type":"string",
            "description":"Date when the purchase order was shipped.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentHeaderId":{
            "title":"Shipment Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the shipment header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineLocationId":{
            "title":"Purchase Order Line Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies purchase order shipment schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item in a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"Number that identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POHeaderId":{
            "title":"Purchase Order Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "title":"Purchase Order Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies purchase order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuantityReceived":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Received quantity corresponding to the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipmentLineId":{
            "title":"Shipment Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the shipment line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt Number",
            "maxLength":30,
            "type":"string",
            "description":"Receipt number for the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : purchaseOrderSchedulesForLandedCosts-tradeOperationDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ChargeLineStatus":{
            "title":"Charge Line Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredBUCurrencyCode":{
            "title":"Charge BU Functional Currency",
            "maxLength":15,
            "type":"string",
            "description":"Functional currency of the charge business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalEstimatedAmount":{
            "title":"Estimated Amount",
            "type":"number",
            "description":"Total estimated amount incurred on the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the trade operation to which the charge line belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargeLineNumber":{
            "title":"Charge Line Number",
            "type":"number",
            "description":"Number that identifies the trade operation charge line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationId":{
            "title":"Trade Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TradeOperationNumber":{
            "title":"Number",
            "maxLength":40,
            "type":"string",
            "description":"Number that identifies the trade operation to which the charge line belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalActualAmount":{
            "title":"Actual Amount",
            "type":"number",
            "description":"Total actual amount incurred on the trade operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Charge Name",
            "maxLength":80,
            "type":"string",
            "description":"Charge name for which the estimates and actual amounts are entered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

shipmentDetails

Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderSchedulesForLandedCosts/{POLineLocationId}/child/shipmentDetails

Parameters:

• POLineLocationId: $request.path.POLineLocationId

The Shipment Details resource gets the information of shipments associated with the purchase order schedule.

tradeOperationDetails

Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderSchedulesForLandedCosts/{POLineLocationId}/child/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.

Back to Top

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": 
...
}

Back to Top