Get all summary attributes
get
/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/summaryAttributes
Request
Path Parameters
-
draftPurchaseOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Draft Purchase Orders resource and used to uniquely identify an instance of Draft Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Orders collection resource in order to navigate to a specific instance of Draft Purchase Orders to get the hash key.
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:- DeliveryAndAmountSummaryFinder: Finds aggregated delivery, requester, charge account, project, and purchase order amount information across active lines and distributions in a purchase order. The summary contains information about whether all the lines are delivered to the same location and the corresponding location details. It specifies if all the distributions are charged to the same charge account and provides corresponding account details. It specifies if all the distributions have same Requester and provides corresponding Requester details. It retrieves the purchase order ordered amount (with inclusive tax), total tax(exclusive) and the total amount in the functional currency. It also specifies if the same project and task is applied on all distributions and provides corresponding project and task details.
Finder Variables: - PrimaryKey: Finds summary attributes for the purchase order according to the primary key.
Finder Variables:- POHeaderId; integer; Value that uniquely identifies the purchase order.
- DeliveryAndAmountSummaryFinder: Finds aggregated delivery, requester, charge account, project, and purchase order amount information across active lines and distributions in a purchase order. The summary contains information about whether all the lines are delivered to the same location and the corresponding location details. It specifies if all the distributions are charged to the same charge account and provides corresponding account details. It specifies if all the distributions have same Requester and provides corresponding Requester details. It retrieves the purchase order ordered amount (with inclusive tax), total tax(exclusive) and the total amount in the functional currency. It also specifies if the same project and task is applied on all distributions and provides corresponding project and task details.
-
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 -
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 : draftPurchaseOrders-summaryAttributes
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 : draftPurchaseOrders-summaryAttributes-item-response
Type:
Show Source
object
-
ChargeToSingleAccountFlag: boolean
Contains one of the following values: true or false. If true, the charge account is the same for all distributions so all the purchase order (PO) distributions are charged to the same charge account. If false, then the charge account is different for each distribution so the PO distributions are charged to different charge accounts. The default value is false.
-
ChartOfAccountId: number
Value that uniquely identifies the chart of accounts.
-
DeliverToCustomerLocationAddress: string
Maximum Length:
255
Physical address of the onetime location where the buying company needs to deliver the goods received from a supplier. -
DeliverToCustomerLocationId: integer
Value that uniquely identifies the one time location where the buying company should deliver the goods that were previously received from a supplier.
-
DeliverToLocationCode: string
Abbreviation that identifies the final location where the buying company should deliver the goods that were previously received from a supplier.
-
DeliverToLocationId: integer
Value that uniquely identifies the final location where the buying company should deliver the goods that were previously received from a supplier.
-
DeliverToSingleLocationFlag: boolean
Contains one of the following values: true or false. If true, all the purchase order distributions have the same delivery location. If false, then the delivery location is different on distributions. The default value is false.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Ordered: number
Sum Total of purchase order amounts across all lines.
-
POChargeAccount: string
Account that the purchase from a purchase order is charged to.
-
POChargeAccountId: integer
Value that uniquely identifies the account that the purchase from a purchase order is charged to.
-
POHeaderId: integer
Value that uniquely identifies the purchase order.
-
ProjectCostingDetailsCode: string
Contains one of the following values: NONE, SINGLE, or MULTIPLE. If none of the distributions have project costing details associated with them, the attribute value is set to NONE. If all the distributions have exactly the same project and task associated with them, it is set to SINGLE. If the project and task associated with the distributions are different, it is set to MULTIPLE.
-
ProjectId: number
Value that uniquely identifies the project.
-
ProjectName: string
Maximum Length:
240
Name of the project, which is displayed on the purchase order header. -
ProjectNumber: string
Maximum Length:
25
Number of the project, which is displayed on the purchase order header. -
ProjectsInformationAcrossLines: string
Contains one of the following values: NONE, SINGLE, or MULTIPLE. If none of the distributions have project costing details associated with them, the attribute value is set to NONE. If all the distributions have the same project associated with them and the costing details are exactly the same, it is set to SINGLE. If the project costing details of the distributions are different, it is set to MULTIPLE.
-
RequestedDeliveryDate: string
(date)
Date when the buying company requested the ordered item or service to be delivered.
-
Requester: string
Display name of the person for whom goods or services are being ordered. The value is set to Null if the requester is different across purchase order distributions.
-
RequesterId: string
Value that uniquely identifies the person for whom goods or services are being ordered. The value is set to Null if the requester is different across the purchase order distributions.
-
SameRequestedDeliveryDateFlag: boolean
Contains one of the following values: true or false. If true, all the purchase order schedules carry the same requested delivery date value. If false, then the requested delivery date is different on schedules. The default value is false.
-
SameRequesterIdFlag: boolean
Contains one of the following values: true or false. If true, all the purchase order lines are ordered for the same person. If false, the purchase order are ordered for different persons. This attribute doesn't have a default value.
-
TaskId: number
Value that uniquely identifies the Task.
-
TaskName: string
Name of the project task, which is displayed on the purchase order.
-
TaskNumber: string
Maximum Length:
240
Number of the project task, which is displayed on the purchase order. -
Total: number
Sum Total of Ordered and Total Tax amount.
-
TotalTax: number
Sum total of exclusive tax (nonrecoverable and recoverable) amounts on a purchase order expressed in the functional currency.
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.
Examples
This example describes how to use the finder in the cURL command to get summarized information about Deliver-to locations, charge accounts, projects, and requester and amounts from the lines, schedules, and distributions of a purchase order.
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/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/summaryAttributes"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100580259972/child/summaryAttributes?finder=DeliveryAndAmountSummaryFinder&onlyData=true"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "items": [ { "POHeaderId": 300100580259972, "DeliverToLocationCode": null, "DeliverToLocationId": null, "DeliverToSingleLocationFlag": false, "DeliverToCustomerLocationId": 0, "ProjectCostingDetailsCode": "NONE", "ProjectId": 0, "ProjectNumber": null, "ProjectName": null, "RequesterId": "100010026864135", "SameRequesterIdFlag": true, "Requester": "Penelope Antilla", "RequestedDeliveryDate": "2023-07-17", "SameRequestedDeliveryDateFlag": true, "TaskNumber": null, "TaskName": null, "ProjectsInformationAcrossLines": "NONE", "POChargeAccountId": 188976, "ChargeToSingleAccountFlag": true, "POChargeAccount": "00-000-2440-0000-000", "Ordered": 12, "TotalTax": 0, "Total": 12, "TaskId": 0, "DeliverToCustomerLocationAddress": null, "ChartOfAccountId": 101 } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://server/fscmRestApi/resources/version/draftPurchaseOrders/300100580259972/child/summaryAttributes", "name": "summaryAttributes", "kind": "collection" } ] }