Create a purchase order schedule
post
/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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AllocationBaseFactor: number
Title:
Allocation Base FactorBase factor value used for charge allocation. -
AllocationCurrencyCode: string
Title:
Allocation CurrencyMaximum Length:15Currency used for charge allocation. -
AllocationPercentage: number
Title:
Allocation PercentagePercentage used for charge allocation. -
AllocationRate: number
Title:
Allocation RateRate to be applied to purchase order schedules for deriving the charge estimates. -
LandedCostPOScheduleId: integer
(int64)
Title:
Landed Cost PO Schedule IDValue that uniquely identifies the purchase order schedule for landed cost. -
OrderedQuantity: number
Title:
Ordered QuantityQuantity on the purchase order schedule. -
POItemPrice: number
Title:
Item PriceItem price on the purchase order. -
POPrimaryUOMCode: string
Maximum Length:
3Value 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. -
POSecondaryUOMCode: string
Maximum Length:
3Value that identifies the secondary unit of measure for the purchase order schedule quantity. -
UOMTypeCode: string
Title:
UOM TypeMaximum Length:30Value that identifies the unit of measure used for charge allocation.
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.
Root Schema : tradeOperations-charges-chargePurchaseOrderSchedules-item-response
Type:
Show Source
object-
ActAmountInDocumentCurrency: number
Title:
Allocated Actual Amount in Trade Operation CurrencyRead Only:trueActual amount on the charge line in the trade operation currency. -
ActAmountInFuncCurrency: number
Title:
Allocated Actual Amount in Functional CurrencyRead Only:trueActual amount on the charge line in the functional currency. -
ActAmountInMatRequisitionBUCurrency: number
Title:
Allocated Actual Amount in Material Requisition BU CurrencyRead Only:trueActual 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 CurrencyRead Only:trueActual per unit amount on the charge line in the trade operation currency. -
ActAmountPERUnitInFuncCurrency: number
Title:
Allocated Actual per Unit Amount in Functional CurrencyRead Only:trueActual per unit amount on the charge line in the functional currency. -
ActAmountPERUnitInMatRequisitionBUCurrency: number
Title:
Allocated Actual per Unit Amount in Material Requisition BU CurrencyRead Only:trueActual 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 CurrencyRead Only:trueActual non-recoverable tax on the charge line in the trade operation currency. -
ActTaxInFuncCurrency: number
Title:
Allocated Actual NonRecoverable Tax in Functional CurrencyRead Only:trueActual non-recoverable tax on the charge line in the functional currency. -
ActTaxInMatRequisitionBUCurrency: number
Title:
Allocated Actual NonRecoverable Tax in Material Requisition BU CurrencyRead Only:trueActual 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 CurrencyRead Only:trueActual 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 CurrencyRead Only:trueActual 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 CurrencyRead Only:trueActual 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 FactorBase factor value used for charge allocation. -
AllocationCurrencyCode: string
Title:
Allocation CurrencyMaximum Length:15Currency used for charge allocation. -
AllocationPercentage: number
Title:
Allocation PercentagePercentage used for charge allocation. -
AllocationRate: number
Title:
Allocation RateRate to be applied to purchase order schedules for deriving the charge estimates. -
DeliverToInvOrg: string
Title:
Delivered-to Inventory Organization NameRead Only:trueMaximum Length:240Name of the inventory organization to which the item is delivered. -
DeliverToInvOrgId: integer
(int64)
Title:
Delivered-To Inventory Organization IDRead Only:trueValue that uniquely identifies the inventory organization to which the item is delivered. -
DestinationType: string
Title:
Destination TypeRead Only:trueMaximum Length:80Destination type on the purchase order. -
EstAmountInChargeCurrency: number
Title:
Allocated Estimate Amount in Charge CurrencyRead Only:trueEstimated amount on the charge line in the charge currency. -
EstAmountInDocumentCurrency: number
Title:
Allocated Estimate Amount in Trade Operation CurrencyRead Only:trueEstimated amount on the charge line in the trade operation currency. -
EstAmountInFunCurrency: number
Title:
Allocated Estimate Amount in Functional CurrencyRead Only:trueEstimated amount on the charge line in the functional currency. -
EstAmountInMatRequisitionBUCurrency: number
Title:
Allocated Estimate Amount in Material Requisition BU CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated per unit amount on the charge line in the charge currency. -
EstAmountPERUnitInDocumentCurrency: number
Title:
Allocated Estimate per Unit Amount in Trade Operation CurrencyRead Only:trueEstimated per unit amount on the charge line in the trade operation currency. -
EstAmountPERUnitInFuncCurrency: number
Title:
Allocated Estimate per Unit Amount in Functional CurrencyRead Only:trueEstimated per unit amount on the charge line in the functional currency. -
EstAmountPERUnitInMatRequisitionBUCurrency: number
Title:
Allocated Estimate per Unit Amount in Material Requisition BU CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated non-recoverable tax on the charge line in the trade operation currency. -
EstTaxInFuncCurrency: number
Title:
Allocated Estimate NonRecoverable Tax in Functional CurrencyRead Only:trueEstimated non-recoverable tax on the charge line in the functional currency. -
EstTaxInMatRequisitionBUCurrency: number
Title:
Allocated Estimate NonRecoverable Tax in Material Requisitioning BU CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated 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 CurrencyRead Only:trueEstimated non-recoverable tax on the charge line in the charge currency. -
ItemId: integer
(int64)
Title:
Item IDRead Only:trueValue that uniquely identifies the item. -
ItemNumber: string
Read Only:
trueMaximum Length:300Item on the purchase order schedule. -
LandedCostPOScheduleId: integer
(int64)
Title:
Landed Cost PO Schedule IDValue that uniquely identifies the purchase order schedule for landed cost. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderedQuantity: number
Title:
Ordered QuantityQuantity on the purchase order schedule. -
POHeaderId: integer
(int64)
Title:
Purchase Order Header IDRead Only:trueValue that uniquely identifies the purchase order header. -
POItemPrice: number
Title:
Item PriceItem price on the purchase order. -
POLineId: integer
(int64)
Title:
Purchase Order Line IDRead Only:trueValue that uniquely identifies the purchase order line. -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location IDRead Only:trueValue that uniquely identifies the purchase order shipment schedule. -
POLineNumber: string
Title:
Purchase Order LineRead Only:trueMaximum Length:40Number that identifies the line in the purchase order. -
PONumber: string
Title:
Purchase OrderRead Only:trueMaximum Length:40Number that identifies the material purchase order for the landed cost estimate. -
POPrimaryUOMCode: string
Maximum Length:
3Value 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 AmountRead Only:trueAmount on the purchase order schedule line. -
POScheduleFuncCurrencyAmount: number
Title:
PO Schedule Functional Currency AmountRead Only:trueFunctional currency amount on the purchase order schedule line. -
POScheduleNumber: string
Title:
Purchase Order ScheduleRead Only:trueMaximum Length:40Number that identifies the schedule of the material purchase order line used for the landed cost estimate. -
POSecondaryUOMCode: string
Maximum Length:
3Value that identifies the secondary unit of measure for the purchase order schedule quantity. -
ProcurementBU: string
Title:
Procurement BURead Only:trueMaximum Length:240Procurement business unit on the purchase order schedule. -
ProcurementBUId: integer
(int64)
Title:
Procurement Business Unit IDRead Only:trueValue that uniquely identifies the procurement business unit for the material purchase order schedule. -
ProfitCenterBU: string
Title:
Profit Center BURead Only:trueMaximum Length:240Profit center business unit on the purchase order schedule. -
ProfitCenterBUId: integer
(int64)
Title:
Profit Center BU IDRead Only:trueValue that uniquely identifies the profit center business unit for the material purchase order schedule. -
ReceiptQuantity: number
Title:
Receipt QuantityRead Only:trueReceived quantity corresponding to the purchase order schedule. -
RequisitioningBU: string
Title:
Requisitioning BURead Only:trueMaximum Length:240Requisitioning business unit on the purchase order schedule. -
RequisitioningBUId: integer
(int64)
Title:
Requisitioning BU IDRead Only:trueValue that uniquely identifies the requisitioning business unit for the material purchase order schedule. -
ShiptoLocation: string
Title:
Ship-to LocationRead Only:trueMaximum Length:240Location to which the item is delivered. -
ShipToLocationId: integer
(int64)
Title:
Ship-To Location IDRead Only:trueValue that uniquely identifies the location to which the item is delivered. -
Supplier: string
Title:
SupplierRead Only:trueMaximum Length:360Supplier on the purchase order. -
SupplierSite: string
Title:
Supplier SiteRead Only:trueMaximum Length:240Supplier site on the purchase order. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site IDRead Only:trueValue that uniquely identifies the supplier site on the purchase order. -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:25Unit of measure for the purchase order schedule quantity. -
UOMTypeCode: string
Title:
UOM TypeMaximum Length:30Value that identifies the unit of measure used for charge allocation.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.