Get summary attributes for one order
get
/fscmRestApi/resources/11.13.18.05/requisitionLifecycleDetails/{RequisitionHeaderId}/child/orderSummaryAttributes/{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=
-
RequisitionHeaderId(required): integer
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:
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 : requisitionLifecycleDetails-orderSummaryAttributes-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
true
Value of the goods and services delivered to the buying organization. -
FunctionalCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the currency of the sold-to legal entity. -
FunctionalOrderedAmount: number
Read Only:
true
Value of the order in the currency of the sold-to legal entity. -
HasOnlyAmountBasedLinesFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether all the lines are services billed by amount. If true, then all the lines are services billed by amount. If false, then all the lines aren't services billed by amount. -
InReceivingAmount: number
Read Only:
true
Value of the goods received by the buying organization, currently in receiving, not delivered or returned. -
InTransitAmount: number
Read Only:
true
Value of goods shipped by the supplier but yet to be received at the buying organization. -
InvoicedAmount: number
Read Only:
true
Amount equivalent of the matched invoice lines based on the purchase price. -
InvoiceUnpaidAmount: number
Read Only:
true
Unpaid amount of the invoice. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpenDate: string
(date)
Read Only:
true
Date when the purchase order is open for execution. -
OrderedAmount: number
Read Only:
true
Value of the order in the purchase order currency. -
PartiallyPaidInvoiceAmount: number
Read Only:
true
Partially paid amount of the invoice. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order. -
ProcessingStatusCode: string
Read Only:
true
Maximum Length:11
Abbreviation that identifies whether requisition lines are processed in an open purchase order. Valid values are PROCESSED and UNPROCESSED. -
PurchaseOrder: string
Read Only:
true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. - relatedDocuments: array Related Documents of a Purchase Order
-
RequisitionHeaderId: number
Read Only:
true
Value that uniquely identifies the requisition. -
Supplier: string
Read Only:
true
Maximum Length:360
Supplier who fulfills the purchase order.
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.
Links
- relatedDocuments
-
Parameters:
- POHeaderId:
$request.path.POHeaderId
- RequisitionHeaderId:
$request.path.RequisitionHeaderId
The Related Documents resource retrieves the count of all unprocessed lines, negotiations, and documents such as shipments, receipts, invoices, if any, for a purchase order. - POHeaderId: