Get receipt details for all schedules of a purchase order
get
/fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/receipts
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 -
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 receipts details according to the primary key.
Finder Variables- LineLocationId; integer; Value that uniquely identifies the purchase order schedule associated with the receipt.
- ReceiptId; integer; Value that uniquely identifies the receipt.
- PrimaryKey Finds receipts details according to the primary key.
-
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:- InConsignedInventory; number; Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed.
- LineDescription; string; Description of the item that the purchase order references.
- LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
- LineNumber; number; Number that uniquely identifies the purchase order line.
- POHeaderId; number; Value that uniquely identifies the purchase order.
- POLineId; number; Value that uniquely identifies the purchase order line.
- ReceiptId; integer; Value that uniquely identifies the receipt.
- ScheduleDescription; string; Description of the work associated with the progress payment schedule.
- ScheduleNumber; number; Number that uniquely identifies the purchase order schedule for the purchase order line.
-
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: 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-receipts
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 : purchaseOrderLifeCycleDetails-receipts-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:15
Code that identifies the purchase order currency. -
DeliveredAmount: number
Read Only:
true
Amount delivered against the purchase order schedule for the service lines. -
DeliveredQuantity: number
Read Only:
true
Ordered quantity that has been delivered. -
DeliveredWithQualifier: string
Title:
Delivered
Read Only:true
Maximum Length:255
Quantity or amount delivered against the purchase order schedule. -
InConsignedInventory: number
Read Only:
true
Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. -
InConsignedInventoryWithQualifier: string
Title:
In Consigned Inventory
Read Only:true
Maximum Length:255
Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. Value shown with UOM code. -
InvoicedAmount: number
Read Only:
true
Ordered amount that has been invoiced. -
InvoicedQuantity: number
Read Only:
true
Ordered quantity that has been invoiced. -
InvoicedWithQualifier: string
Title:
Invoiced
Read Only:true
Maximum Length:255
Quantity or amount invoiced against the purchase order schedule. -
ItemOrScheduleDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Either the description of the item or the work associated with the progress payment schedule. -
LineDescription: string
Read Only:
true
Maximum Length:240
Description of the item that the purchase order references. -
LineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
LineNumber: number
Read Only:
true
Number that uniquely identifies the purchase order line. -
LineNumberScheduleNumber: string
Title:
Line - Schedule
Read Only:true
Maximum Length:81
Line and schedule number for a purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OpenToInvoiceAmount: number
Read Only:
true
Ordered amount that hasn't been invoiced yet. -
OpenToInvoiceQuantity: number
Read Only:
true
Ordered quantity that hasn't been invoiced yet. -
OpenToInvoiceWithQualifier: string
Title:
Open to Invoice
Read Only:true
Maximum Length:255
Quantity or amount that hasn't been invoiced yet. -
POHeaderId: number
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineId: number
Read Only:
true
Value that uniquely identifies the purchase order line. -
Receipt: string
Title:
Receipt
Read Only:true
Maximum Length:30
Number that identifies the receipt. -
ReceiptDate: string
(date)
Title:
Date
Read Only:true
Date when goods or services were received. -
ReceiptId: integer
(int64)
Read Only:
true
Value that uniquely identifies the receipt. -
ReceivedAmount: number
Read Only:
true
Amount received against the purchase order schedule for service lines. -
ReceivedBy: string
Title:
Received By
Read Only:true
Maximum Length:240
Name of the person who received the goods or services. -
ReceivedInSecondaryQuantity: number
Read Only:
true
Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item. -
ReceivedInSecondaryQuantityWithQualifier: string
Title:
Received in Secondary
Read Only:true
Maximum Length:255
Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item shown with the UOM code. -
ReceivedQuantity: number
Read Only:
true
Ordered quantity that has been received. -
ReceivedWithQualifier: string
Title:
Received
Read Only:true
Maximum Length:255
Ordered quantity that has been received shown with the UOM code. -
ReturnedQuantity: number
Read Only:
true
Ordered quantity that has been returned. -
ReturnedWithQualifier: string
Title:
Returned
Read Only:true
Maximum Length:255
Ordered quantity that has been returned shown with the UOM code. -
ReturnToSupplierType: string
Title:
Return for Credit
Read Only:true
Maximum Length:25
Type of the return to supplier transaction. Contains one of the following values: Return For Credit or Return For Replacement. -
ScheduleDescription: string
Read Only:
true
Maximum Length:240
Description of the work associated with the progress payment schedule. -
ScheduleNumber: number
Read Only:
true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
SecondaryUOM: string
Read Only:
true
Maximum Length:3
An alternative UOM that's allowed to quantify a dual UOM-controlled item. -
SecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item. -
ShipmentId: number
Read Only:
true
Value that uniquely identifies the shipment. -
ShipmentNumber: string
Title:
Shipment
Read Only:true
Maximum Length:50
Number that identifies the shipment. -
UOM: string
Read Only:
true
Maximum Length:25
Unit of measure that the item uses for quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure.
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.