Jump to

• Request
• Response

Get all the purchase order schedules

get

/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/charges/{TradeOperationChargeId}/child/chargePurchaseOrderSchedules

Request

Path Parameters

• TradeOperationChargeId(required): integer(int64)
  Value that uniquely identifies the trade operation charge.
• TradeOperationId(required): integer(int64)
  Value that uniquely identifies the trade operation.

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
• finder: string
  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: Finds purchase order schedules associated with a charge line.
    Finder Variables:
  • findChargePurchaseOrderScheds: Finds associated purchase order schedules to a charge line according to the specified attributes.
    Finder Variables:
    • bindActAmtInDocCurr; number; Allocated actual charge amount in trade operation currency to the purchase order schedule.
    • bindEstAmtInDocCurr; number; Allocated estimated charge amount in trade operation currency to the purchase order schedule.
    • bindItemNumber; string; Number that identifies the item on the purchase order.
    • bindOrderedQty; string; Quantity ordered in the purchase order.
    • bindPOLineNumber; string; Number that identifies the purchase order line.
    • bindPONumber; string; Number that identifies the purchase order.
    • bindPOSchedAmount; number; Amount in the purchase order schedule.
    • bindPOScheduleNumber; string; Number that identifies the purchase order schedule.
    • bindProcurementBU; string; Name of the procurement business unit.
    • bindProfitCenterBU; string; Name of the profit center business unit.
    • bindRequisitioningBU; string; Name of the requisitioning business unit on the purchase order.
    • bindSupplier; string; Name of the supplier on the purchase order.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • ActAmountInDocumentCurrency; number; Actual amount on the charge line in the trade operation currency.
  • ActAmountInFuncCurrency; number; Actual amount on the charge line in the functional currency.
  • ActAmountInMatRequisitionBUCurrency; number; Actual amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • ActAmountPERUnitInDocumentCurrency; number; Actual per unit amount on the charge line in the trade operation currency.
  • ActAmountPERUnitInFuncCurrency; number; Actual per unit amount on the charge line in the functional currency.
  • ActAmountPERUnitInMatRequisitionBUCurrency; number; Actual per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • ActTaxInDocumentCurrency; number; Actual non-recoverable tax on the charge line in the trade operation currency.
  • ActTaxInFuncCurrency; number; Actual non-recoverable tax on the charge line in the functional currency.
  • ActTaxInMatRequisitionBUCurrency; number; Actual non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • ActTaxPERUnitInDocumentCurrency; number; Actual per unit non-recoverable tax on the charge line in the trade operation currency.
  • ActTaxPERUnitInFuncCurrency; number; Actual per unit non-recoverable tax on the charge line in the functional currency.
  • ActTaxPERUnitInMatRequisitionBUCurrency; number; Actual per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • AllocationBaseFactor; number; Base factor value used for charge allocation.
  • AllocationCurrencyCode; string; Currency used for charge allocation.
  • AllocationPercentage; number; Percentage used for charge allocation.
  • AllocationRate; number; Rate to be applied to purchase order schedules for deriving the charge estimates.
  • DeliverToInvOrg; string; Name of the inventory organization to which the item is delivered.
  • DeliverToInvOrgId; integer; Value that uniquely identifies the inventory organization to which the item is delivered.
  • DestinationType; string; Destination type on the purchase order.
  • EstAmountInChargeCurrency; number; Estimated amount on the charge line in the charge currency.
  • EstAmountInDocumentCurrency; number; Estimated amount on the charge line in the trade operation currency.
  • EstAmountInFunCurrency; number; Estimated amount on the charge line in the functional currency.
  • EstAmountInMatRequisitionBUCurrency; number; Estimated amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • EstAmountPERUnitInChargeCurrency; number; Estimated per unit amount on the charge line in the charge currency.
  • EstAmountPERUnitInDocumentCurrency; number; Estimated per unit amount on the charge line in the trade operation currency.
  • EstAmountPERUnitInFuncCurrency; number; Estimated per unit amount on the charge line in the functional currency.
  • EstAmountPERUnitInMatRequisitionBUCurrency; number; Estimated per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
  • EstTaxInDocumentCurrency; number; Estimated non-recoverable tax on the charge line in the trade operation currency.
  • EstTaxInFuncCurrency; number; Estimated non-recoverable tax on the charge line in the functional currency.
  • EstTaxInMatRequisitionBUCurrency; number; Estimated non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • EstTaxPERUnitInChargeCurrency; number; Estimated per unit non-recoverable tax on the charge line in the charge currency.
  • EstTaxPERUnitInDocumentCurrency; number; Estimated per unit non-recoverable tax on the charge line in the trade operation currency.
  • EstTaxPERUnitInFuncCurrency; number; Estimated per unit non-recoverable tax on the charge line in the functional currency.
  • EstTaxPERUnitInMatRequisitionBUCurrency; number; Estimated per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
  • EstTaxtInChargeCurrency; number; Estimated non-recoverable tax on the charge line in the charge currency.
  • ItemId; integer; Value that uniquely identifies the item.
  • ItemNumber; string; Item on the purchase order schedule.
  • LandedCostPOScheduleId; integer; Value that uniquely identifies the purchase order schedule for landed cost.
  • OrderedQuantity; number; Quantity on the purchase order schedule.
  • POHeaderId; integer; Value that uniquely identifies the purchase order header.
  • POItemPrice; number; Item price on the purchase order.
  • POLineId; integer; Value that uniquely identifies the purchase order line.
  • POLineLocationId; integer; Value that uniquely identifies the purchase order shipment schedule.
  • POLineNumber; string; Number that identifies the line in the purchase order.
  • PONumber; string; Number that identifies the material purchase order for the landed cost estimate.
  • POPrimaryUOMCode; string; Value that identifies the primary unit of measure for the purchase order schedule quantity.
  • POQuantityInPrimaryUOM; number; Ordered quantity on the purchase order in the primary unit of measure.
  • POQuantityInSecondaryUOM; number; Ordered quantity on the purchase order in the secondary unit of measure.
  • POScheduleAmount; number; Amount on the purchase order schedule line.
  • POScheduleFuncCurrencyAmount; number; Functional currency amount on the purchase order schedule line.
  • POScheduleNumber; string; Number that identifies the schedule of the material purchase order line used for the landed cost estimate.
  • POSecondaryUOMCode; string; Value that identifies the secondary unit of measure for the purchase order schedule quantity.
  • ProcurementBU; string; Procurement business unit on the purchase order schedule.
  • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit for the material purchase order schedule.
  • ProfitCenterBU; string; Profit center business unit on the purchase order schedule.
  • ProfitCenterBUId; integer; Value that uniquely identifies the profit center business unit for the material purchase order schedule.
  • ReceiptQuantity; number; Received quantity corresponding to the purchase order schedule.
  • RequisitioningBU; string; Requisitioning business unit on the purchase order schedule.
  • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit for the material purchase order schedule.
  • ShipToLocationId; integer; Value that uniquely identifies the location to which the item is delivered.
  • ShiptoLocation; string; Location to which the item is delivered.
  • Supplier; string; Supplier on the purchase order.
  • SupplierSite; string; Supplier site on the purchase order.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site on the purchase order.
  • UOMTypeCode; string; Value that identifies the unit of measure used for charge allocation.
  • UnitOfMeasure; string; Unit of measure for the purchase order schedule quantity.
• totalResults: boolean
  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

• 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 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 : tradeOperations-charges-chargePurchaseOrderSchedules

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/tradeOperations-charges-chargePurchaseOrderSchedules-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object tradeOperations-charges-chargePurchaseOrderSchedules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/tradeOperations-charges-chargePurchaseOrderSchedules-item-response"
    }
}

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 : tradeOperations-charges-chargePurchaseOrderSchedules-item-response

Type: object

Show Source

• ActAmountInDocumentCurrency: number
  Title: Allocated Actual Amount in Trade Operation Currency

  Read Only: true

  Actual amount on the charge line in the trade operation currency.
• ActAmountInFuncCurrency: number
  Title: Allocated Actual Amount in Functional Currency

  Read Only: true

  Actual amount on the charge line in the functional currency.
• ActAmountInMatRequisitionBUCurrency: number
  Title: Allocated Actual Amount in Material Requisition BU Currency

  Read Only: true

  Actual amount on the charge line in the functional currency of the business unit that is requisitioning the material.
• ActAmountPERUnitInDocumentCurrency: number
  Title: Allocated Actual per Unit Amount in Trade Operation Currency

  Read Only: true

  Actual per unit amount on the charge line in the trade operation currency.
• ActAmountPERUnitInFuncCurrency: number
  Title: Allocated Actual per Unit Amount in Functional Currency

  Read Only: true

  Actual per unit amount on the charge line in the functional currency.
• ActAmountPERUnitInMatRequisitionBUCurrency: number
  Title: Allocated Actual per Unit Amount in Material Requisition BU Currency

  Read Only: true

  Actual per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
• ActTaxInDocumentCurrency: number
  Title: Allocated Actual NonRecoverable Tax in Trade Operation Currency

  Read Only: true

  Actual non-recoverable tax on the charge line in the trade operation currency.
• ActTaxInFuncCurrency: number
  Title: Allocated Actual NonRecoverable Tax in Functional Currency

  Read Only: true

  Actual non-recoverable tax on the charge line in the functional currency.
• ActTaxInMatRequisitionBUCurrency: number
  Title: Allocated Actual NonRecoverable Tax in Material Requisition BU Currency

  Read Only: true

  Actual non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
• ActTaxPERUnitInDocumentCurrency: number
  Title: Allocated Actual per Unit NonRecoverable Tax in Trade Operation Currency

  Read Only: true

  Actual per unit non-recoverable tax on the charge line in the trade operation currency.
• ActTaxPERUnitInFuncCurrency: number
  Title: Allocated Actual per Unit NonRecoverable Tax in Functional Currency

  Read Only: true

  Actual per unit non-recoverable tax on the charge line in the functional currency.
• ActTaxPERUnitInMatRequisitionBUCurrency: number
  Title: Allocated Actual per Unit NonRecoverable Tax in Material Requisition BU Currency

  Read Only: true

  Actual per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
• AllocationBaseFactor: number
  Title: Allocation Base Factor

  Base factor value used for charge allocation.
• AllocationCurrencyCode: string
  Title: Allocation Currency

  Maximum Length: 15

  Currency used for charge allocation.
• AllocationPercentage: number
  Title: Allocation Percentage

  Percentage used for charge allocation.
• AllocationRate: number
  Title: Allocation Rate

  Rate to be applied to purchase order schedules for deriving the charge estimates.
• DeliverToInvOrg: string
  Title: Delivered-to Inventory Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the inventory organization to which the item is delivered.
• DeliverToInvOrgId: 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.
• EstAmountInChargeCurrency: number
  Title: Allocated Estimate Amount in Charge Currency

  Read Only: true

  Estimated amount on the charge line in the charge currency.
• EstAmountInDocumentCurrency: number
  Title: Allocated Estimate Amount in Trade Operation Currency

  Read Only: true

  Estimated amount on the charge line in the trade operation currency.
• EstAmountInFunCurrency: number
  Title: Allocated Estimate Amount in Functional Currency

  Read Only: true

  Estimated amount on the charge line in the functional currency.
• EstAmountInMatRequisitionBUCurrency: number
  Title: Allocated Estimate Amount in Material Requisition BU Currency

  Read Only: true

  Estimated amount on the charge line in the functional currency of the business unit that is requisitioning the material.
• EstAmountPERUnitInChargeCurrency: number
  Title: Allocated Estimate per Unit Amount in Charge Currency

  Read Only: true

  Estimated per unit amount on the charge line in the charge currency.
• EstAmountPERUnitInDocumentCurrency: number
  Title: Allocated Estimate per Unit Amount in Trade Operation Currency

  Read Only: true

  Estimated per unit amount on the charge line in the trade operation currency.
• EstAmountPERUnitInFuncCurrency: number
  Title: Allocated Estimate per Unit Amount in Functional Currency

  Read Only: true

  Estimated per unit amount on the charge line in the functional currency.
• EstAmountPERUnitInMatRequisitionBUCurrency: number
  Title: Allocated Estimate per Unit Amount in Material Requisition BU Currency

  Read Only: true

  Estimated per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.
• EstTaxInDocumentCurrency: number
  Title: Allocated Estimate NonRecoverable Tax in Trade Operation Currency

  Read Only: true

  Estimated non-recoverable tax on the charge line in the trade operation currency.
• EstTaxInFuncCurrency: number
  Title: Allocated Estimate NonRecoverable Tax in Functional Currency

  Read Only: true

  Estimated non-recoverable tax on the charge line in the functional currency.
• EstTaxInMatRequisitionBUCurrency: number
  Title: Allocated Estimate NonRecoverable Tax in Material Requisitioning BU Currency

  Read Only: true

  Estimated non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
• EstTaxPERUnitInChargeCurrency: number
  Title: Allocated Estimate per Unit NonRecoverable Tax in Charge Currency

  Read Only: true

  Estimated per unit non-recoverable tax on the charge line in the charge currency.
• EstTaxPERUnitInDocumentCurrency: number
  Title: Allocated Estimate per Unit NonRecoverable Tax in Trade Operation Currency

  Read Only: true

  Estimated per unit non-recoverable tax on the charge line in the trade operation currency.
• EstTaxPERUnitInFuncCurrency: number
  Title: Allocated Estimate per Unit NonRecoverable Tax in Functional Currency

  Read Only: true

  Estimated per unit non-recoverable tax on the charge line in the functional currency.
• EstTaxPERUnitInMatRequisitionBUCurrency: number
  Title: Allocated Estimate per Unit NonRecoverable Tax in Material Requisition BU Currency

  Read Only: true

  Estimated per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.
• EstTaxtInChargeCurrency: number
  Title: Allocated Estimate NonRecoverable Tax in Charge Currency

  Read Only: true

  Estimated non-recoverable tax on the charge line in the charge currency.
• ItemId: integer (int64)
  Title: Item ID

  Read Only: true

  Value that uniquely identifies the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Item on the purchase order schedule.
• LandedCostPOScheduleId: integer (int64)
  Title: Landed Cost PO Schedule ID

  Value that uniquely identifies the purchase order schedule for landed cost.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderedQuantity: number
  Title: Ordered Quantity

  Quantity on the purchase order schedule.
• POHeaderId: integer (int64)
  Title: Purchase Order Header ID

  Read Only: true

  Value that uniquely identifies the purchase order header.
• POItemPrice: number
  Title: Item Price

  Item price on the purchase order.
• POLineId: integer (int64)
  Title: Purchase Order Line ID

  Read Only: true

  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Title: Purchase Order Line Location ID

  Read Only: true

  Value that uniquely identifies the purchase order shipment schedule.
• POLineNumber: string
  Title: Purchase Order Line

  Read Only: true

  Maximum Length: 40

  Number that identifies the line in the purchase order.
• PONumber: string
  Title: Purchase Order

  Read Only: true

  Maximum Length: 40

  Number that identifies the material purchase order for the landed cost estimate.
• POPrimaryUOMCode: string
  Maximum Length: 3

  Value that identifies the primary unit of measure for the purchase order schedule quantity.
• POQuantityInPrimaryUOM: number
  Title: Ordered Quantity (Secondary UOM)

  Ordered quantity on the purchase order in the primary unit of measure.
• POQuantityInSecondaryUOM: number
  Title: Ordered Quantity (Secondary UOM)

  Ordered quantity on the purchase order in the secondary unit of measure.
• POScheduleAmount: number
  Title: PO Schedule Amount

  Read Only: true

  Amount on the purchase order schedule line.
• POScheduleFuncCurrencyAmount: number
  Title: PO Schedule Functional Currency Amount

  Read Only: true

  Functional currency amount on the purchase order schedule line.
• POScheduleNumber: string
  Title: Purchase Order Schedule

  Read Only: true

  Maximum Length: 40

  Number that identifies the schedule of the material purchase order line used for the landed cost estimate.
• POSecondaryUOMCode: string
  Maximum Length: 3

  Value that identifies the secondary unit of measure for the purchase order schedule quantity.
• 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 the profit center business unit for the material purchase order schedule.
• ReceiptQuantity: number
  Title: Receipt Quantity

  Read Only: true

  Received quantity corresponding to the purchase order schedule.
• 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.
• ShiptoLocation: string
  Title: Ship-to Location

  Read Only: true

  Maximum Length: 240

  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.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  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.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 25

  Unit of measure for the purchase order schedule quantity.
• UOMTypeCode: string
  Title: UOM Type

  Maximum Length: 30

  Value that identifies the unit of measure used for charge allocation.

{
    "type":"object",
    "properties":{
        "PONumber":{
            "title":"Purchase Order",
            "maxLength":"40",
            "type":"string",
            "description":"Number that identifies the material purchase order for the landed cost estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleAmount":{
            "title":"PO Schedule Amount",
            "type":"number",
            "description":"Amount on the purchase order schedule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"number_edit",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EstTaxPERUnitInMatRequisitionBUCurrency":{
            "title":"Allocated Estimate per Unit NonRecoverable Tax in Material Requisition BU Currency",
            "type":"number",
            "description":"Estimated per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShiptoLocation":{
            "title":"Ship-to Location",
            "maxLength":"240",
            "type":"string",
            "description":"Location to which the item is delivered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineLocationId":{
            "title":"Purchase Order Line Location ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order shipment schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ActTaxInDocumentCurrency":{
            "title":"Allocated Actual NonRecoverable Tax in Trade Operation Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the charge line in the trade operation currency.",
            "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",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ActAmountPERUnitInFuncCurrency":{
            "title":"Allocated Actual per Unit Amount in Functional Currency",
            "type":"number",
            "description":"Actual per unit amount on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountInChargeCurrency":{
            "title":"Allocated Estimate Amount in Charge Currency",
            "type":"number",
            "description":"Estimated amount on the charge line in the charge currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInFuncCurrency":{
            "title":"Allocated Estimate NonRecoverable Tax in Functional Currency",
            "type":"number",
            "description":"Estimated non-recoverable tax on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInMatRequisitionBUCurrency":{
            "title":"Allocated Estimate per Unit Amount in Material Requisition BU Currency",
            "type":"number",
            "description":"Estimated per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProfitCenterBUId":{
            "title":"Profit Center BU ID",
            "type":"integer",
            "description":"Value that uniquely identifies the profit center business unit for the material purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"number_edit",
                "precision":"18"
            },
            "x-queryable":true
        },
        "POPrimaryUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the primary unit of measure for the purchase order schedule quantity.",
            "nullable":false,
            "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":"default"
            },
            "x-queryable":true
        },
        "ProfitCenterBU":{
            "title":"Profit Center BU",
            "maxLength":"240",
            "type":"string",
            "description":"Profit center business unit on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POItemPrice":{
            "title":"Item Price",
            "type":"number",
            "description":"Item price on the purchase order.",
            "nullable":false,
            "x-queryable":true
        },
        "AllocationCurrencyCode":{
            "title":"Allocation Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Currency used for charge allocation.",
            "nullable":false,
            "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 the purchase order line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "POQuantityInPrimaryUOM":{
            "title":"Ordered Quantity (Secondary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the primary unit of measure.",
            "nullable":false,
            "x-queryable":true
        },
        "AllocationRate":{
            "title":"Allocation Rate",
            "type":"number",
            "description":"Rate to be applied to purchase order schedules for deriving the charge estimates.",
            "nullable":true,
            "x-queryable":true
        },
        "EstTaxPERUnitInFuncCurrency":{
            "title":"Allocated Estimate per Unit NonRecoverable Tax in Functional Currency",
            "type":"number",
            "description":"Estimated per unit non-recoverable tax on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "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":{
                "controlType":"number_edit",
                "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-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure for the purchase order schedule quantity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "POScheduleFuncCurrencyAmount":{
            "title":"PO Schedule Functional Currency Amount",
            "type":"number",
            "description":"Functional currency amount on the purchase order schedule line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationPercentage":{
            "title":"Allocation Percentage",
            "type":"number",
            "description":"Percentage used for charge allocation.",
            "nullable":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":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ActAmountPERUnitInDocumentCurrency":{
            "title":"Allocated Actual per Unit Amount in Trade Operation Currency",
            "type":"number",
            "description":"Actual per unit amount on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxInFuncCurrency":{
            "title":"Allocated Actual NonRecoverable Tax in Functional Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllocationBaseFactor":{
            "title":"Allocation Base Factor",
            "type":"number",
            "description":"Base factor value used for charge allocation.",
            "nullable":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInDocumentCurrency":{
            "title":"Allocated Estimate per Unit Amount in Trade Operation Currency",
            "type":"number",
            "description":"Estimated per unit amount on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxInDocumentCurrency":{
            "title":"Allocated Estimate NonRecoverable Tax in Trade Operation Currency",
            "type":"number",
            "description":"Estimated non-recoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Supplier site on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "EstTaxInMatRequisitionBUCurrency":{
            "title":"Allocated Estimate NonRecoverable Tax in Material Requisitioning BU Currency",
            "type":"number",
            "description":"Estimated non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountInDocumentCurrency":{
            "title":"Allocated Estimate Amount in Trade Operation Currency",
            "type":"number",
            "description":"Estimated amount on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActAmountInDocumentCurrency":{
            "title":"Allocated Actual Amount in Trade Operation Currency",
            "type":"number",
            "description":"Actual amount on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POQuantityInSecondaryUOM":{
            "title":"Ordered Quantity (Secondary UOM)",
            "type":"number",
            "description":"Ordered quantity on the purchase order in the secondary unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "ActAmountInFuncCurrency":{
            "title":"Allocated Actual Amount in Functional Currency",
            "type":"number",
            "description":"Actual amount on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxPERUnitInDocumentCurrency":{
            "title":"Allocated Actual per Unit NonRecoverable Tax in Trade Operation Currency",
            "type":"number",
            "description":"Actual per unit non-recoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationType":{
            "title":"Destination Type",
            "maxLength":"80",
            "type":"string",
            "description":"Destination type on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxPERUnitInDocumentCurrency":{
            "title":"Allocated Estimate per Unit NonRecoverable Tax in Trade Operation Currency",
            "type":"number",
            "description":"Estimated per unit non-recoverable tax on the charge line in the trade operation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"Purchase Order Schedule",
            "maxLength":"40",
            "type":"string",
            "description":"Number that identifies the schedule of the material purchase order line used for the landed cost estimate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInFuncCurrency":{
            "title":"Allocated Estimate per Unit Amount in Functional Currency",
            "type":"number",
            "description":"Estimated per unit amount on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Item on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "POHeaderId":{
            "title":"Purchase Order Header ID",
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "ActAmountInMatRequisitionBUCurrency":{
            "title":"Allocated Actual Amount in Material Requisition BU Currency",
            "type":"number",
            "description":"Actual amount on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxPERUnitInMatRequisitionBUCurrency":{
            "title":"Allocated Actual per Unit NonRecoverable Tax in Material Requisition BU Currency",
            "type":"number",
            "description":"Actual per unit non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "ActTaxInMatRequisitionBUCurrency":{
            "title":"Allocated Actual NonRecoverable Tax in Material Requisition BU Currency",
            "type":"number",
            "description":"Actual non-recoverable tax on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POSecondaryUOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that identifies the secondary unit of measure for the purchase order schedule quantity.",
            "nullable":true,
            "x-queryable":true
        },
        "EstAmountPERUnitInChargeCurrency":{
            "title":"Allocated Estimate per Unit Amount in Charge Currency",
            "type":"number",
            "description":"Estimated per unit amount on the charge line in the charge currency.",
            "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",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "EstAmountInFunCurrency":{
            "title":"Allocated Estimate Amount in Functional Currency",
            "type":"number",
            "description":"Estimated amount on the charge line in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToInvOrg":{
            "title":"Delivered-to Inventory Organization Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the inventory organization to which the item is delivered.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxPERUnitInChargeCurrency":{
            "title":"Allocated Estimate per Unit NonRecoverable Tax in Charge Currency",
            "type":"number",
            "description":"Estimated per unit non-recoverable tax on the charge line in the charge currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMTypeCode":{
            "title":"UOM Type",
            "maxLength":"30",
            "type":"string",
            "description":"Value that identifies the unit of measure used for charge allocation.",
            "nullable":false,
            "x-queryable":true
        },
        "OrderedQuantity":{
            "title":"Ordered Quantity",
            "type":"number",
            "description":"Quantity on the purchase order schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "POLineNumber":{
            "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
        },
        "EstAmountInMatRequisitionBUCurrency":{
            "title":"Allocated Estimate Amount in Material Requisition BU Currency",
            "type":"number",
            "description":"Estimated amount on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliverToInvOrgId":{
            "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
        },
        "ActAmountPERUnitInMatRequisitionBUCurrency":{
            "title":"Allocated Actual per Unit Amount in Material Requisition BU Currency",
            "type":"number",
            "description":"Actual per unit amount on the charge line in the functional currency of the business unit that is requisitioning the material.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EstTaxtInChargeCurrency":{
            "title":"Allocated Estimate NonRecoverable Tax in Charge Currency",
            "type":"number",
            "description":"Estimated non-recoverable tax on the charge line in the charge currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptQuantity":{
            "title":"Receipt Quantity",
            "type":"number",
            "description":"Received quantity corresponding to the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActTaxPERUnitInFuncCurrency":{
            "title":"Allocated Actual per Unit NonRecoverable Tax in Functional Currency",
            "type":"number",
            "description":"Actual per unit non-recoverable tax on the charge line in the functional currency.",
            "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 : 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."
        }
    }
}

Back to Top