Jump to

• Request
• Response
• Examples

Get all summary attributes

get

/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/summaryAttributes

Request

Path Parameters

• purchaseRequisitionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Requisitions resource and used to uniquely identify an instance of Purchase Requisitions. The client should not generate the hash key value. Instead, the client should query on the Purchase Requisitions collection resource in order to navigate to a specific instance of Purchase Requisitions 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, charge account, project, and requisition amount information across active lines and distributions in a requisition. The summary contains information about whether or not 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 retrieves the total requisition amount, the total nonrecoverable tax amount, and the requisition approval amount in the functional currency. It also specifies if the same project is applied to all distributions and provides corresponding project information.
    Finder Variables:
    • HeaderStatus; string; Value that identifies the requisition status.
  • IMTLinesSummaryFinder: Finds summary information about internal material transfer lines in a requisition. The summary includes the total number of internal material transfer lines and the number of lines for which the transfer price hasn't been derived.
    Finder Variables:
  • OneTimeLocationAcrossRequisitionFinder: Finds the count of the one-time location ID across different requisitions.
    Finder Variables:
    • bindOneTimeLocationId; integer; Value of the one-time location ID to find the one-time location count across requisitions.
    • bindRequisitionLineId; integer.
  • OneTimeLocationAcrossRequisitionLineFinder: Finds the count of one-time location ID across different requisition lines.
    Finder Variables:
    • bindOneTimeLocationId; integer; Value of the one-time location ID to find the one-time location count across requisition lines.
    • bindRequisitionLineId; integer; Value of the requisition line ID to find the one-time location count across other requisition lines.
  • OrdersAndBuyersSummaryFinder: Finds aggregated order and buyer information across lines in a requisition. The summary includes number of requisition lines excluding split and replaced lines, number of purchase orders that were opened, first purchase order number that has been moved to open status, first buyer either from the purchase order or the assigned buyer from the approved or returned requisition lines, and number of distinct buyers.
    Finder Variables:
  • PrimaryKey: Finds summary attributes for the purchase requisition according to the primary key.
    Finder Variables:
    • RequisitionHeaderId; integer; Value that uniquely identifies the requisition.
  • RequisitionDetailsSummaryFinder: Finds aggregated delivery information across all lines in a requisition. The summary contains information about whether or not all the lines are delivered to the same requester and the same location, and the corresponding requester and location details.
    Finder Variables:
• 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:
  

  • OneTimeLocationCountAcrossRequisition; integer; Total count of the one-time locations available across requisition. This count doesn't include one-time location for the current requisition.
  • OneTimeLocationCountAcrossRequisitionLine; integer; Total count of the one-time locations available across requisition lines. This count doesn't include one-time location for the current requisition 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:
  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 Top

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.

Body ()

Root Schema : purchaseRequisitions-summaryAttributes

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseRequisitions-summaryAttributes-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseRequisitions-summaryAttributes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseRequisitions-summaryAttributes-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : purchaseRequisitions-summaryAttributes-item-response

Type: object

Show Source

• AccountUserOverrideFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y, or N, or Null. If Y, the charge account is updated by the user on all the requisition lines. If N, the charge account isn't updated by the user on all the requisition lines. If Null, the charge account is updated by the user on some of the requisition lines.
• ActiveLineCount: number
  Number of requisition lines excluding split and replaced lines for the requisition.
• Buyer: string
  Maximum Length: 255

  Name of the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle.
• BuyerCount: number
  Number of buyers from the orders that were opened or assigned to the lines for the requisition.
• BuyerId: integer
  Value that uniquely identifies the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle.
• CategoryId: integer
  Value that uniquely identifies the purchasing category across all the requisition lines. The value is set to Null if the purchasing category is different across the requisition lines.
• ChargeAccount: string
  Title: Charge Account

  Maximum Length: 255

  Account that the purchase from a requisition is charged to.
• ChargeAccountId: integer
  Value that uniquely identifies the account that the purchase from a requisition is charged to.
• ChargeToSingleAccountFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines are charged to the same charge account. If false, then the charge account is different on lines. The default value is false.
• ContainsNoneditableLinesFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the requisition contains lines that can't be edited. If false, then it doesn't contain noneditable lines. The default value is false.
• DeliverToLocationCode: string
  Title: Deliver-to Location

  Maximum Length: 255

  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.
• DeliverToOneTimeLocationAddress: string
  Title: One-Time Location Address

  Maximum Length: 255

  Physical address of the one time location where the buying company should deliver the goods previously received from a supplier.
• DeliverToOneTimeLocationId: integer
  Value that uniquely identifies the one time location where the buying company should deliver the goods that were previously received from a supplier.
• DeliverToSingleLocationFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines have the same delivery location. If false, then the delivery location is different on lines. The default value is false.
• DestinationTypeCode: string
  Maximum Length: 255

  Value that uniquely identifies the destination type code on the requisition lines. The value is set to Null if the destination type code is different across the requisition lines.
• HasAllMasterItemsFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then all the requisition lines are for master items. This attribute doesn't have a default value.
• HasOneTimeLocAcrossLinesFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then at least one of the requisition lines has a one-time deliver-to location type. This attribute doesn't have a default value.
• LineCount: number
  Number of lines in the requisition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumSequenceNumber: integer
  Value that's used to generate the identification key for a requisition.
• OneTimeLocationCountAcrossRequisition: integer
  Total count of the one-time locations available across requisition. This count doesn't include one-time location for the current requisition.
• OneTimeLocationCountAcrossRequisitionLine: integer
  Total count of the one-time locations available across requisition lines. This count doesn't include one-time location for the current requisition line.
• POHeaderId: integer
  Value that uniquely identifies first purchase order that was opened for the requisition.
• ProjectCostingDetailsCode: string
  Maximum Length: 25

  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 requisition header.
• ProjectNumber: string
  Maximum Length: 25

  Number of the project, which is displayed on the requisition header.
• ProjectsInformationAcrossLines: string
  Maximum Length: 25

  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.
• PurchaseOrder: string
  Maximum Length: 255

  Number that identifies the first purchase order that was opened for the requisition.
• PurchaseOrderCount: number
  Number of purchase orders that were opened for the requisition.
• RequestedDeliveryDate: string (date)
  Title: Requested Delivery Date

  Date when the buying company requested the ordered item or service to be delivered.
• Requester: string
  Maximum Length: 240

  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 requisition lines.
• RequesterId: integer
  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 requisition lines.
• RequisitionApprovalAmount: number
  Title: Approval Amount

  Sum total of RequisitionTotalAmount and RequisitionNonRecoverableTaxAmount expressed in the functional currency.
• RequisitionHeaderId: integer
  Value that uniquely identifies the requisition.
• RequisitionNonRecoverableTaxAmount: number
  Title: Nonrecoverable Tax

  Sum total of nonrecoverable tax amounts across all requisition lines expressed in the functional currency.
• RequisitionTotalAmount: number
  Title: Requisition Amount

  Sum total of distribution amounts across all requisition lines expressed in the functional currency.
• SameAccountUserOverrideFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines have the charge account either updated or not updated by the user. If false, the charge account is updated on some of the requisition lines by the user. This attribute doesn't have a default value.
• SameCategoryIdFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines have the same purchasing category. If false, the purchasing category is different across the requisition lines. This attribute doesn't have a default value.
• SameDestinationOrganizationIdFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then all the lines in the requisition contain the same destination organization ID.
• SameDestinationSubinventoryFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then all the requisition lines have the same destination subinventory attribute. This attribute doesn't have a default value.
• SameDestinationTypeCodeFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines have the same destination type. If false, the destination type is different on the requisition lines. This attribute doesn't have a default value.
• SameRequestedDeliveryDateFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines carry the same requested delivery date value. If false, then the requested delivery date is different on lines. The default value is false.
• SameRequesterIdFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines are ordered for the same person. If false, the requisition lines are ordered for different persons. This attribute doesn't have a default value.
• SameVendorIdFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, all the requisition lines have the same supplier. If false, the supplier is different across the requisition lines. This attribute doesn't have a default value.
• TaskName: string
  Maximum Length: 240

  Name of the project task, which is displayed on the requisition header.
• TaskNumber: string
  Maximum Length: 240

  Number of the project task, which is displayed on the requisition header.
• TOHeaderId: integer
  Value that uniquely identifies the first transfer order that was opened for the requisition.
• TotalIMTLinesCount: number
  Number of internal material transfer lines in a requisition.
• TransferOrder: string
  Maximum Length: 255

  Number that identifies the first transfer order that was opened for the requisition.
• TransferOrderCount: number
  Number of transfer orders that were opened for the requisition.
• UnprocessedIMTLinesCount: number
  Number of internal material transfer lines in a requisition for which the transfer price hasn't been derived.
• VendorId: integer
  Value that uniquely identifies the supplier across all the requisition lines. The value is set to Null if the supplier is different across the requisition lines.

{
    "type":"object",
    "properties":{
        "UnprocessedIMTLinesCount":{
            "type":"number",
            "description":"Number of internal material transfer lines in a requisition for which the transfer price hasn't been derived.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeAccount":{
            "title":"Charge Account",
            "maxLength":"255",
            "type":"string",
            "description":"Account that the purchase from a requisition is charged to.",
            "nullable":true,
            "x-queryable":false
        },
        "ActiveLineCount":{
            "type":"number",
            "description":"Number of requisition lines excluding split and replaced lines for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "HasAllMasterItemsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all the requisition lines are for master items. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineCount":{
            "type":"number",
            "description":"Number of lines in the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "MaximumSequenceNumber":{
            "type":"integer",
            "description":"Value that's used to generate the identification key for a requisition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Requester":{
            "maxLength":"240",
            "type":"string",
            "description":"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 requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DeliverToOneTimeLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the one time location where the buying company should deliver the goods that were previously received from a supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "SameRequesterIdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines are ordered for the same person. If false, the requisition lines are ordered for different persons. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SameAccountUserOverrideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines have the charge account either updated or not updated by the user. If false, the charge account is updated on some of the requisition lines by the user. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ContainsNoneditableLinesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the requisition contains lines that can't be edited. If false, then it doesn't contain noneditable lines. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "HasOneTimeLocAcrossLinesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then at least one of the requisition lines has a one-time deliver-to location type. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SameVendorIdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines have the same supplier. If false, the supplier is different across the requisition lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SameCategoryIdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines have the same purchasing category. If false, the purchasing category is different across the requisition lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TransferOrder":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the first transfer order that was opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "RequisitionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project task, which is displayed on the requisition header.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TOHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the first transfer order that was opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectsInformationAcrossLines":{
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TotalIMTLinesCount":{
            "type":"number",
            "description":"Number of internal material transfer lines in a requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "SameDestinationSubinventoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all the requisition lines have the same destination subinventory attribute. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category across all the requisition lines. The value is set to Null if the purchasing category is different across the requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProjectName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the project, which is displayed on the requisition header.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliverToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the final location where the buying company should deliver the goods that were previously received from a supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier across all the requisition lines. The value is set to Null if the supplier is different across the requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PurchaseOrderCount":{
            "type":"number",
            "description":"Number of purchase orders that were opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "Buyer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountUserOverrideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: Y, or N, or Null. If Y, the charge account is updated by the user on all the requisition lines. If N, the charge account isn't updated by the user on all the requisition lines. If Null, the charge account is updated by the user on some of the requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequisitionNonRecoverableTaxAmount":{
            "title":"Nonrecoverable Tax",
            "type":"number",
            "description":"Sum total of nonrecoverable tax amounts across all requisition lines expressed in the functional currency.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliverToSingleLocationFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines have the same delivery location. If false, then the delivery location is different on lines. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle.",
            "nullable":true,
            "x-queryable":false
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies first purchase order that was opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "ChargeToSingleAccountFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines are charged to the same charge account. If false, then the charge account is different on lines. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "RequisitionTotalAmount":{
            "title":"Requisition Amount",
            "type":"number",
            "description":"Sum total of distribution amounts across all requisition lines expressed in the functional currency.",
            "nullable":true,
            "x-queryable":false
        },
        "BuyerCount":{
            "type":"number",
            "description":"Number of buyers from the orders that were opened or assigned to the lines for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "OneTimeLocationCountAcrossRequisition":{
            "type":"integer",
            "description":"Total count of the one-time locations available across requisition. This count doesn't include one-time location for the current requisition.",
            "nullable":true,
            "x-queryable":true
        },
        "SameRequestedDeliveryDateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines carry the same requested delivery date value. If false, then the requested delivery date is different on lines. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "TransferOrderCount":{
            "type":"number",
            "description":"Number of transfer orders that were opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliverToLocationCode":{
            "title":"Deliver-to Location",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the final location where the buying company should deliver the goods that were previously received from a supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the destination type code on the requisition lines. The value is set to Null if the destination type code is different across the requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ChargeAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the account that the purchase from a requisition is charged to.",
            "nullable":true,
            "x-queryable":false
        },
        "OneTimeLocationCountAcrossRequisitionLine":{
            "type":"integer",
            "description":"Total count of the one-time locations available across requisition lines. This count doesn't include one-time location for the current requisition line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "maxLength":"25",
            "type":"string",
            "description":"Number of the project, which is displayed on the requisition header.",
            "nullable":true,
            "x-queryable":false
        },
        "DeliverToOneTimeLocationAddress":{
            "title":"One-Time Location Address",
            "maxLength":"255",
            "type":"string",
            "description":"Physical address of the one time location where the buying company should deliver the goods previously received from a supplier.",
            "nullable":true,
            "x-queryable":false
        },
        "ProjectId":{
            "type":"number",
            "description":"Value that uniquely identifies the project.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Number of the project task, which is displayed on the requisition header.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequesterId":{
            "type":"integer",
            "description":"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 requisition lines.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequisitionApprovalAmount":{
            "title":"Approval Amount",
            "type":"number",
            "description":"Sum total of RequisitionTotalAmount and RequisitionNonRecoverableTaxAmount expressed in the functional currency.",
            "nullable":true,
            "x-queryable":false
        },
        "PurchaseOrder":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the first purchase order that was opened for the requisition.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "type":"string",
            "description":"Date when the buying company requested the ordered item or service to be delivered.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SameDestinationTypeCodeFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, all the requisition lines have the same destination type. If false, the destination type is different on the requisition lines. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ProjectCostingDetailsCode":{
            "maxLength":"25",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "SameDestinationOrganizationIdFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all the lines in the requisition contain the same destination organization ID.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

In this example, you use the finder in the following cURL command to get number of requisition lines excluding split and replaced lines, number of purchase orders that were opened, first purchase order number that has been moved to open status, first buyer either from the open purchase order or the assigned buyer from the approved or returned requisition lines, and number of distinct buyers.

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/purchaseRequisitions/purchaseRequisitionsUniqID/child/summaryAttributes?finder=OrdersAndBuyersSummaryFinder"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"RequisitionHeaderId": 300100195673138,
		"ActiveLineCount": 4,
		"PurchaseOrderCount": 2,
		"BuyerCount": 2,
		"PurchaseOrder": "1005761",
		"Buyer": "Clare Jones",
		"BuyerId": 100010026863783,
		"POHeaderId": 300100195673174,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseRequisitions/300100195673138/child/summaryAttributes/300100195673138",
			"name": "summaryAttributes",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseRequisitions/300100195673138/child/summaryAttributes/300100195673138",
			"name": "summaryAttributes",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/purchaseRequisitions/300100195673138",
			"name": "purchaseRequisitions",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseRequisitions/300100195673138/child/summaryAttributes",
		"name": "summaryAttributes",
		"kind": "collection"
	}
	]
}

Back to Top