Get life cycle details for one purchase order
get
/fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}
Request
Path Parameters
-
POHeaderId(required): number
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : purchaseOrderLifeCycleDetails-item-response
Type:
Show Source
object-
CurrencyCode: string
Read Only:
trueMaximum Length:15Code that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
trueValue of the goods and services delivered to the buying organization. -
InReceivingAmount: number
Read Only:
trueValue of the goods received by the buying organization, currently in receiving, not delivered or returned. -
InTransitAmount: number
Read Only:
trueValue of goods shipped by the supplier, but yet to be received at the buying organization. -
invoices: array
Invoices
Title:
InvoicesThe details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderedAmount: number
Read Only:
trueTotal amount of the order according to the quantities and prices of the goods and service items specified on the order. -
OrderNumber: string
Title:
OrderRead Only:trueMaximum Length:30Number that uniquely identifies the purchase order in the sold-to legal entity. -
PaidAmount: number
Read Only:
trueInvoiced amount that has been paid. -
PartiallyPaidAmount: number
Read Only:
trueInvoiced amount that has been partially paid. -
POHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase order. -
receipts: array
Receipts
Title:
ReceiptsThe details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received. -
schedules: array
Schedules
Title:
SchedulesThe details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced. -
shipments: array
Shipments
Title:
ShipmentsThe details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments. -
UnpaidAmount: number
Read Only:
trueInvoiced amount that hasn't been paid.
Nested Schema : Invoices
Type:
arrayTitle:
InvoicesThe details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Receipts
Type:
arrayTitle:
ReceiptsThe details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received.
Show Source
Nested Schema : Schedules
Type:
arrayTitle:
SchedulesThe details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced.
Show Source
Nested Schema : Shipments
Type:
arrayTitle:
ShipmentsThe details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments.
Show Source
Nested Schema : purchaseOrderLifeCycleDetails-invoices-item-response
Type:
Show Source
object-
ConsumptionAdvice: string
Read Only:
trueMaximum Length:20Number that identifies the consumption advice associated with the invoice line. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Code that identifies the purchase order currency. -
HoldReasonCode: string
Read Only:
trueMaximum Length:4000Abbreviation that identifies the reason for the invoice hold. -
Invoice: string
Title:
InvoiceRead Only:trueMaximum Length:50Number that identifies the invoice. -
InvoicedDate: string
(date)
Title:
DateRead Only:trueDate when the goods or services were invoiced. -
InvoiceId: number
Read Only:
trueValue that uniquely identifies the invoice. -
InvoiceStatus: string
Title:
StatusRead Only:trueMaximum Length:255Status of the invoice. -
InvoiceStatusCode: string
Read Only:
trueMaximum Length:14Abbreviation that identifies the invoice status. -
InvoiceType: string
Title:
TypeRead Only:trueMaximum Length:50Type of the invoice. Contains one of the following values: Prepayment, Credit Memo, Debit Memo or Standard Invoice. -
ItemOrScheduleDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Either the description of the item or the work associated with the progress payment schedule. -
LineDescription: string
Read Only:
trueMaximum Length:240Description of the item that the purchase order references. -
LineLocationId: number
Read Only:
trueValue that uniquely identifies the purchase order schedule. -
LineNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order line. -
LineNumberScheduleNumber: string
Title:
Line - ScheduleRead Only:trueMaximum Length:81Line and schedule number for a purchase order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MatchedAmount: number
Read Only:
trueInvoice amount matched to the purchase order schedule. -
MatchedAmountWithQualifier: string
Title:
Matched AmountRead Only:trueMaximum Length:255Invoice amount matched to the purchase order schedule shown with the currency code. -
MatchedQuantity: number
Read Only:
trueInvoice quantity matched to the purchase order schedule. -
MatchedQuantityWithQualifier: string
Title:
Matched QuantityRead Only:trueMaximum Length:255Invoice quantity matched to the purchase order schedule shown with the UOM code. -
POHeaderId: number
Read Only:
trueValue that uniquely identifies the purchase order. -
POLineId: number
Read Only:
trueValue that uniquely identifies the purchase order line. -
Receipt: string
Title:
ReceiptRead Only:trueMaximum Length:30Number that identifies the receipt. -
ReceiptId: number
Read Only:
trueValue that uniquely identifies the receipt. -
ScheduleDescription: string
Read Only:
trueMaximum Length:240Description of the work associated with the progress payment schedule. -
ScheduleNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order schedule for the purchase order line. -
TotalInvoicedAmount: number
Read Only:
trueTotal amount of an invoice. -
TotalInvoicedAmountWithQualifier: string
Title:
Total Invoiced AmountRead Only:trueMaximum Length:255Total amount of an invoice shown with the currency code. -
UOM: string
Read Only:
trueMaximum Length:25Unit of measure that the item uses for quantity. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : purchaseOrderLifeCycleDetails-receipts-item-response
Type:
Show Source
object-
CurrencyCode: string
Read Only:
trueMaximum Length:15Code that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
trueAmount delivered against the purchase order schedule for the service lines. -
DeliveredQuantity: number
Read Only:
trueOrdered quantity that has been delivered. -
DeliveredWithQualifier: string
Title:
DeliveredRead Only:trueMaximum Length:255Quantity or amount delivered against the purchase order schedule. -
InConsignedInventory: number
Read Only:
trueDenotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. -
InConsignedInventoryWithQualifier: string
Title:
In Consigned InventoryRead Only:trueMaximum Length:255Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. Value shown with UOM code. -
InvoicedAmount: number
Read Only:
trueOrdered amount that has been invoiced. -
InvoicedQuantity: number
Read Only:
trueOrdered quantity that has been invoiced. -
InvoicedWithQualifier: string
Title:
InvoicedRead Only:trueMaximum Length:255Quantity or amount invoiced against the purchase order schedule. -
ItemOrScheduleDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Either the description of the item or the work associated with the progress payment schedule. -
LineDescription: string
Read Only:
trueMaximum Length:240Description of the item that the purchase order references. -
LineLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase order schedule. -
LineNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order line. -
LineNumberScheduleNumber: string
Title:
Line - ScheduleRead Only:trueMaximum Length:81Line and schedule number for a purchase order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OpenToInvoiceAmount: number
Read Only:
trueOrdered amount that hasn't been invoiced yet. -
OpenToInvoiceQuantity: number
Read Only:
trueOrdered quantity that hasn't been invoiced yet. -
OpenToInvoiceWithQualifier: string
Title:
Open to InvoiceRead Only:trueMaximum Length:255Quantity or amount that hasn't been invoiced yet. -
POHeaderId: number
Read Only:
trueValue that uniquely identifies the purchase order. -
POLineId: number
Read Only:
trueValue that uniquely identifies the purchase order line. -
Receipt: string
Title:
ReceiptRead Only:trueMaximum Length:30Number that identifies the receipt. -
ReceiptDate: string
(date)
Title:
DateRead Only:trueDate when goods or services were received. -
ReceiptId: integer
(int64)
Read Only:
trueValue that uniquely identifies the receipt. -
ReceivedAmount: number
Read Only:
trueAmount received against the purchase order schedule for service lines. -
ReceivedBy: string
Title:
Received ByRead Only:trueMaximum Length:240Name of the person who received the goods or services. -
ReceivedInSecondaryQuantity: number
Read Only:
trueOrdered quantity that has been received in the secondary UOM of a dual UOM-controlled item. -
ReceivedInSecondaryQuantityWithQualifier: string
Title:
Received in SecondaryRead Only:trueMaximum Length:255Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item shown with the UOM code. -
ReceivedQuantity: number
Read Only:
trueOrdered quantity that has been received. -
ReceivedWithQualifier: string
Title:
ReceivedRead Only:trueMaximum Length:255Ordered quantity that has been received shown with the UOM code. -
ReturnedQuantity: number
Read Only:
trueOrdered quantity that has been returned. -
ReturnedWithQualifier: string
Title:
ReturnedRead Only:trueMaximum Length:255Ordered quantity that has been returned shown with the UOM code. -
ReturnToSupplierType: string
Title:
Return for CreditRead Only:trueMaximum Length:25Type of the return to supplier transaction. Contains one of the following values: Return For Credit or Return For Replacement. -
ScheduleDescription: string
Read Only:
trueMaximum Length:240Description of the work associated with the progress payment schedule. -
ScheduleNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order schedule for the purchase order line. -
SecondaryUOM: string
Read Only:
trueMaximum Length:3An alternative UOM that's allowed to quantify a dual UOM-controlled item. -
SecondaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item. -
ShipmentId: number
Read Only:
trueValue that uniquely identifies the shipment. -
ShipmentNumber: string
Title:
ShipmentRead Only:trueMaximum Length:50Number that identifies the shipment. -
UOM: string
Read Only:
trueMaximum Length:25Unit of measure that the item uses for quantity. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrderLifeCycleDetails-schedules-item-response
Type:
Show Source
object-
CurrencyCode: string
Read Only:
trueMaximum Length:15Code that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
trueAmount delivered against the purchase order schedule for service lines. -
DeliveredQuantity: number
Read Only:
trueOrdered quantity or amount that has been delivered. -
DeliveredWithQualifier: string
Title:
DeliveredRead Only:trueMaximum Length:255Quantity or amount delivered against the purchase order schedule. -
DueDate: string
(date)
Title:
Due DateRead Only:trueDate when the goods are requested or promised for delivery. -
HasMultipleReceiptsFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the purchase order schedule has multiple receipts or not. Valid values are true and false. -
InReceivingQuantity: number
Read Only:
trueOrdered quantity received by the buying organization, currently in receiving, and not delivered, or returned. -
InReceivingQuantityWithQualifier: string
Title:
In ReceivingRead Only:trueMaximum Length:255Ordered quantity received by the buying organization, currently in receiving, and not delivered, or returned. Value is shown with UOM code. -
InTransitQuantity: number
Read Only:
trueOrdered quantity shipped by the supplier, but yet to be received at the buying organization. -
InTransitQuantityWithQualifier: string
Title:
In TransitRead Only:trueMaximum Length:255Ordered quantity shipped by the supplier, but yet to be received at the buying organization. Value is shown with the UOM code. -
InvoicedAmount: number
Read Only:
trueOrdered amount that has been invoiced. -
InvoicedAmountWithQualifier: string
Title:
Invoiced AmountRead Only:trueMaximum Length:255Ordered amount that has been invoiced shown with the currency code. -
InvoicedQuantity: number
Read Only:
trueOrdered quantity that has been invoiced. -
InvoicedQuantityWithQualifier: string
Title:
Invoiced QuantityRead Only:trueMaximum Length:255Ordered quantity that has been invoiced shown with the UOM code. -
ItemOrScheduleDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Either the description of the item or the work associated with the progress payment schedule. -
LineDescription: string
Read Only:
trueMaximum Length:240Description of the item that the purchase order references. -
LineLocationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase order schedule. -
LineNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order line. -
LineNumberScheduleNumber: string
Title:
Line - ScheduleRead Only:trueMaximum Length:81Line and schedule number for a purchase order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OpenToInvoiceAmount: number
Read Only:
trueOrdered amount that hasn't been invoiced yet. -
OpenToInvoiceQuantity: number
Read Only:
trueOrdered quantity that hasn't been invoiced yet. -
OpenToInvoiceWithQualifier: string
Title:
Open to InvoiceRead Only:trueMaximum Length:255Quantity or amount that hasn't been invoiced yet. -
OrderedAmount: number
Read Only:
trueTotal amount ordered for this purchase order schedule. -
OrderedAmountWithQualifier: string
Title:
Ordered AmountRead Only:trueMaximum Length:255Total amount ordered for this purchase order schedule shown with the currency code. -
OrderedInSecondaryQuantity: number
Read Only:
trueOrdered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item. -
OrderedInSecondaryQuantityWithQualifier: string
Title:
Ordered in SecondaryRead Only:trueMaximum Length:255Ordered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code. -
OrderedQuantity: number
Read Only:
trueTotal quantity ordered for this purchase order schedule. -
OrderedQuantityWithQualifier: string
Title:
Ordered QuantityRead Only:trueMaximum Length:255Total quantity ordered for this purchase order schedule shown with the UOM code. -
POHeaderId: number
Read Only:
trueValue that uniquely identifies the purchase order. -
POLineId: number
Read Only:
trueValue that uniquely identifies the purchase order line. -
ReceiptDate: string
(date)
Title:
Receipt DateRead Only:trueDate when the goods or services were received. -
ReceivedAmount: number
Read Only:
trueOrdered amount that has been received. -
ReceivedInSecondaryQuantity: number
Read Only:
trueOrdered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item. -
ReceivedInSecondaryQuantityWithQualifier: string
Title:
Received in SecondaryRead Only:trueMaximum Length:255Ordered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code. -
ReceivedQuantity: number
Read Only:
trueOrdered quantity that has been received. -
ReceivedWithQualifier: string
Title:
ReceivedRead Only:trueMaximum Length:255Quantity or amount received against the purchase order schedule. -
RequestedAmount: number
Read Only:
trueAmount requested on the requisition line associated with the purchase order schedule. -
RequestedQuantity: number
Read Only:
trueQuantity requested on the requisition line associated with the purchase order schedule. -
RequestedWithQualifier: string
Title:
RequestedRead Only:trueMaximum Length:255Quantity or amount requested on the requisition line associated with the purchase order schedule. -
Requisition: string
Read Only:
trueMaximum Length:64Number that identifies the requisition. -
RequisitionLine: number
Read Only:
trueNumber that uniquely identifies the requisition line for the requisition. -
RequisitionNumberLineNumber: string
Title:
Requisition - LineRead Only:trueMaximum Length:105Requisition and line number for a requisition. -
ScheduleDescription: string
Read Only:
trueMaximum Length:240Description of the work associated with the progress payment schedule. -
ScheduleNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order schedule for the purchase order line. -
SecondaryUOM: string
Read Only:
trueMaximum Length:3An alternative UOM that's allowed to quantify a dual UOM-controlled item. -
SecondaryUOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item. -
ShippedQuantity: number
Read Only:
trueTotal number of items shipped by the supplier. -
ShippedQuantityWithQualifier: string
Title:
ShippedRead Only:trueMaximum Length:255Total number of items shipped by the supplier in the purchase order line UOM. -
UOM: string
Read Only:
trueMaximum Length:25Unit of measure that the item uses for quantity. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : purchaseOrderLifeCycleDetails-shipments-item-response
Type:
Show Source
object-
Carrier: string
Title:
CarrierRead Only:trueMaximum Length:360Value that uniquely identifies the carrier on the schedule. -
ExpectedReceiptDate: string
(date)
Title:
Expected Receipt DateRead Only:trueDate when goods are expected to arrive. -
LineDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240Description of the item that the purchase order references. -
LineLocationId: number
Read Only:
trueValue that uniquely identifies the purchase order schedule. -
LineNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order line. -
LineNumberScheduleNumber: string
Title:
Line - ScheduleRead Only:trueMaximum Length:81Line and schedule number for a purchase order. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
POHeaderId: number
Read Only:
trueValue that uniquely identifies the purchase order. -
POLineId: number
Read Only:
trueValue that uniquely identifies the purchase order line. -
ReceiptDate: string
(date)
Title:
Receipt DateRead Only:trueDate when the goods or services were received. -
ScheduleNumber: number
Read Only:
trueNumber that uniquely identifies the purchase order schedule for the purchase order line. -
Shipment: string
Title:
ShipmentRead Only:trueMaximum Length:30Number that identifies the shipment. -
ShipmentId: integer
(int64)
Read Only:
trueValue that uniquely identifies the shipment. -
ShippedDate: string
(date)
Title:
Shipped DateRead Only:trueDate on which goods were shipped. -
ShippedQuantity: number
Read Only:
trueTotal number of items shipped by the supplier. -
ShippedQuantityWithQualifier: string
Title:
QuantityRead Only:trueMaximum Length:255Total number of items shipped by the supplier in the purchase order line UOM. -
Tracking: string
Title:
TrackingRead Only:trueMaximum Length:20Alphanumeric value used for tracking a waybill. -
UOM: string
Read Only:
trueMaximum Length:25Unit of measure that the item uses for quantity. -
UOMCode: string
Read Only:
trueMaximum Length:3Abbreviation that identifies the unit of measure.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- invoices
-
Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/invoicesParameters:
- POHeaderId:
$request.path.POHeaderId
The details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts. - POHeaderId:
- receipts
-
Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/receiptsParameters:
- POHeaderId:
$request.path.POHeaderId
The details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received. - POHeaderId:
- schedules
-
Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/schedulesParameters:
- POHeaderId:
$request.path.POHeaderId
The details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced. - POHeaderId:
- shipments
-
Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/shipmentsParameters:
- POHeaderId:
$request.path.POHeaderId
The details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments. - POHeaderId:
Examples
This example describes how to get the complete procure-to-pay flow for a purchase order, which includes details of requisition lines, purchase order schedules, shipments, receipts, and invoices.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/POHeaderId"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{
"POHeaderId": 300100006795876,
"OrderNumber": "1001121",
"OrderedAmount": 50.00,
"DeliveredAmount": 10.00,
"InReceivingAmount": null,
"InTransitAmount": 10.00,
"PaidAmount": null,
"PartiallyPaidAmount": 10.00,
"UnpaidAmount": null,
"CurrencyCode": "USD",
"schedules": [
{
"POHeaderId": 300100006795876,
"POLineId": 300100006795938,
"LineNumber": 1,
"LineLocationId": 300100006795939,
"ScheduleNumber": 1,
"LineNumberScheduleNumber": "1-1",
"LineDescription": "Plain Item",
"ScheduleDescription": null,
"ItemOrScheduleDescription": "Plain Item",
"Requisition": null,
"RequisitionLine": null,
"RequisitionNumberLineNumber": null,
"RequestedQuantity": null,
"UOM": "Each",
"UOMCode": "Ea",
"RequestedAmount": null,
"CurrencyCode": "USD",
"RequestedWithQualifier": null,
"OrderedQuantity": 50,
"OrderedQuantityWithQualifier": "50 Each",
"OrderedAmount": 50.00,
"OrderedAmountWithQualifier": "50.00 USD",
"ShippedQuantity": 20,
"ShippedQuantityWithQualifier": "20 Each",
"InTransitQuantity": 10,
"InTransitQuantityWithQualifier": "10 Each",
"ReceivedQuantity": 10,
"ReceivedAmount": 10.00,
"ReceivedWithQualifier": "10 Each",
"InReceivingQuantity": null,
"InReceivingQuantityWithQualifier": null,
"DeliveredQuantity": 10,
"DeliveredAmount": null,
"DeliveredWithQualifier": "10 Each",
"InvoicedQuantity": 10,
"InvoicedQuantityWithQualifier": "10 Each",
"InvoicedAmount": 10.00,
"InvoicedAmountWithQualifier": "10.00 USD",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/schedules/300100006795939",
"name": "schedules",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/schedules/300100006795939",
"name": "schedules",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
}
]
}
],
"invoices": [
{
"POHeaderId": 300100006795876,
"POLineId": 300100006795938,
"LineNumber": 1,
"LineLocationId": 300100006795939,
"ScheduleNumber": 1,
"LineNumberScheduleNumber": "1-1",
"LineDescription": "Plain Item",
"ScheduleDescription": null,
"ItemOrScheduleDescription": "Plain Item",
"InvoiceId": 168300,
"Invoice": "ERS-8939-69",
"InvoicedDate": "2012-04-06",
"InvoiceStatusCode": "ON HOLD",
"InvoiceStatus": "On Hold",
"HoldReasonCode": null,
"MatchedQuantity": 10,
"UOM": "Each",
"UOMCode": "Ea",
"MatchedQuantityWithQualifier": "10 Each",
"MatchedAmount": 10.00,
"CurrencyCode": "USD",
"MatchedAmountWithQualifier": "10.00 USD",
"ReceiptId": null,
"Receipt": null,
"ConsumptionAdvice": null,
"TotalInvoicedAmount": 10.99,
"TotalInvoicedAmountWithQualifier": "10.99 USD",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/invoices/000300000129ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E00200007870000000070110F07A4D5AA3787800000125ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E002000078700000000302916C7878FFFFFFFF",
"name": "invoices",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/invoices/000300000129ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E00200007870000000070110F07A4D5AA3787800000125ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E002000078700000000302916C7878FFFFFFFF",
"name": "invoices",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
}
]
}
],
"receipts": [
{
"POHeaderId": 300100006795876,
"POLineId": 300100006795938,
"LineNumber": 1,
"LineLocationId": 300100006795939,
"ScheduleNumber": 1,
"LineNumberScheduleNumber": "1-1",
"LineDescription": "Plain Item",
"ScheduleDescription": null,
"ItemOrScheduleDescription": "Plain Item",
"ReceiptId": 2769322,
"Receipt": "8939",
"ReceiptDate": "2012-04-06",
"ReceivedBy": "Olivia Quinn",
"CurrencyCode": "USD",
"UOM": "Each",
"UOMCode": "Ea",
"ReceivedQuantity": 10,
"ReceivedAmount": null,
"DeliveredQuantity": 10,
"DeliveredAmount": null,
"ReturnedQuantity": null,
"InConsignedInventory": 0,
"ReceivedWithQualifier": "10 Each",
"DeliveredWithQualifier": "10 Each",
"ReturnedWithQualifier": null,
"InConsignedInventoryWithQualifier": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"InvoicedWithQualifier": null,
"OpenToInvoiceQuantity": 0,
"OpenToInvoiceAmount": 0,
"OpenToInvoiceWithQualifier": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/receipts/00020000000EACED00057708000110F07A4D5AA30000000EACED0005770800000000002A41AA",
"name": "receipts",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/receipts/00020000000EACED00057708000110F07A4D5AA30000000EACED0005770800000000002A41AA",
"name": "receipts",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
}
]
}
],
"shipments": [
{
"POHeaderId": 300100006795876,
"POLineId": 300100006795938,
"LineNumber": 1,
"LineLocationId": 300100006795939,
"ScheduleNumber": 1,
"LineNumberScheduleNumber": "1-1",
"LineDescription": "Plain Item",
"ShipmentId": 2769322,
"Shipment": "ASN4/6/2012 12:37:06 AM",
"Carrier": null,
"Tracking": null,
"ShippedDate": "2012-04-06",
"ExpectedReceiptDate": "2012-04-06",
"ShippedQuantity": 20,
"ShippedQuantityWithQualifier": "20 Each",
"UOM": "Each",
"UOMCode": "Ea",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/shipments/000200000129ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E00200007870000000070110F07A4D5AA378780000000EACED0005770800000000002A41AA",
"name": "shipments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/shipments/000200000129ACED0005737200146A6176612E6D6174682E426967446563696D616C54C71557F981284F0300024900057363616C654C0006696E7456616C7400164C6A6176612F6D6174682F426967496E74656765723B787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787000000000737200146A6176612E6D6174682E426967496E74656765728CFC9F1FA93BFB1D030006490008626974436F756E744900096269744C656E67746849001366697273744E6F6E7A65726F427974654E756D49000C6C6F776573745365744269744900067369676E756D5B00096D61676E69747564657400025B427871007E0002FFFFFFFFFFFFFFFFFFFFFFFEFFFFFFFE00000001757200025B42ACF317F8060854E00200007870000000070110F07A4D5AA378780000000EACED0005770800000000002A41AA",
"name": "shipments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876",
"name": "purchaseOrderLifeCycleDetails",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/invoices",
"name": "invoices",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/receipts",
"name": "receipts",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/schedules",
"name": "schedules",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/purchaseOrderLifeCycleDetails/300100006795876/child/shipments",
"name": "shipments",
"kind": "collection"
}
]
}