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.
- PrimaryKey: Finds purchase order schedules associated with a charge line.
-
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : tradeOperations-charges-chargePurchaseOrderSchedules
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : tradeOperations-charges-chargePurchaseOrderSchedules-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.