Jump to

• Request
• Response

Get all awarded lines

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationAwards/{AuctionHeaderId}/child/lines/{LineId}/child/responsesLines

Request

Path Parameters

• AuctionHeaderId(required): integer(int64)
  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=
• LineId(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 the recommended response lines for awarding based on the primary key.
    Finder Variables
    • LineId; integer; Value that uniquely identifies a recommended response line for awarding in a supplier negotiation.
    • Response; integer; Value that uniquely identifies a recommended supplier response for awarding in a supplier negotiation.
• 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:
  

  • AlternateLineDescription; string; Description of an alternate line.
  • AlternateLineFlag; boolean; Value that indicates if alternate lines are present in the negotiation.
  • AuctionHeaderId; integer; Value that uniquely identifies the negotiation.
  • AwardAmount; number; Amount awarded to a supplier response line.
  • AwardInternalNote; string; Note to the internal members entered by the buyer regarding the award decision.
  • AwardNoteToSupplier; string; Note to supplier entered during the award process by the buyer.
  • AwardPrice; number; Price of the awarded line item.
  • AwardQuantity; number; Total quantity of line items awarded in a supplier negotiation.
  • AwardUOM; string; Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.
  • BusinessRelationship; string; Display name of the business relationship of the supplier's enterprise. Values include None, Prospective, and Spend Authorized.
  • GroupType; string; Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.
  • HasQuantityTiersFlag; boolean; Value that indicates whether the line has quantity-based price tiers.
  • HasScoringTeamsFlag; boolean; Value that indicates whether the supplier negotiation has enabled scoring teams to evaluate the requirements.
  • HasShipmentsFlag; boolean; Value that indicates whether the supplier negotiation has shipment enabled for the line items.
  • Line; string; Line number of the negotiation line.
  • LineAmount; number; Total amount of the line item, calculated based on the quantity.
  • LineDescription; string; Description of the negotiation line.
  • LineId; integer; Unique identifier of the negotiation line.
  • LinePrice; number; Price of the line item based on the award quantity.
  • MaximumRetainageAmount; number; Maximum amount of retainage that can be withheld on a line.
  • MinimumReleaseAmount; number; Minimum release amount that the supplier quotes when responding to a negotiation with an agreement outcome.
  • OverriddenScore; number; New score for a given quote or score that replaces the system-computed average score.
  • PartialResponseFlag; boolean; Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.
  • PromisedShipDate; string; Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.
  • Quantity; number; Quantity of the item in the negotiation.
  • Rank; integer; The rank value displayed for the line item based on the response price.
  • Response; integer; Unique identifier of the supplier response in a supplier negotiation.
  • ResponseAmount; number; Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.
  • ResponseStatusCode; string; Value that uniquely identifies the response status.
  • ResponseType; string; Value that uniquely identifies the response.
  • RetainageRatePercent; number; Value that identifies the maximum percentage that can be withheld from an invoice as retainage.
  • Score; number; Value calculated by summing the scores associated with a supplier's responses to requirements specified in the negotiation.
  • ScoreOverriddenFlag; boolean; Contains one of the following values: true or false. If true, then the buyer has overridden the score. If false, then the score isn't overridden.
  • ShortlistFlag; boolean; Value that indicates whether the corresponding bid has been shortlisted.
  • Supplier; string; Name of the supplier who responds to the negotiation.
  • SupplierContact; string; Name of the supplier contact at the supplier that responds to the negotiation.
  • SupplierId; integer; Value that uniquely identifies the supplier.
  • SupplierNumber; string; Unique identifier for the supplier bidder.
  • SupplierSite; string; Name of the supplier site.
  • SupplierSiteId; integer; Value that identifies the supplier site.
  • TransformedAmount; number; Transformed bid total in buyer's currency.
  • TransformedLineAmount; number; Total amount calculated as the quantity multiplied by the transformed price.
  • TransformedPrice; number; The sum of the line price and internal cost factors applied to a supplier for that line item.
  • TransformedRank; integer; Transformed Rank for this particular bid.
  • UnitPriceSavings; number; The savings realized from one unit of the awarded line.
  • UnitPriceSavingsPercent; number; The percentage savings realized from one unit of the awarded 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 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 : supplierNegotiationAwards-lines-responsesLines

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationAwards-lines-responsesLines-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplierNegotiationAwards-lines-responsesLines-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationAwards-lines-responsesLines-item-response"
    }
}

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 : supplierNegotiationAwards-lines-responsesLines-item-response

Type: object

Show Source

• AlternateLineDescription: string
  Read Only: true

  Maximum Length: 2500

  Description of an alternate line.
• AlternateLineFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates if alternate lines are present in the negotiation.
• AuctionHeaderId: integer
  Read Only: true

  Value that uniquely identifies the negotiation.
• AwardAmount: number
  Read Only: true

  Amount awarded to a supplier response line.
• AwardInternalNote: string
  Read Only: true

  Maximum Length: 4000

  Note to the internal members entered by the buyer regarding the award decision.
• AwardNoteToSupplier: string
  Read Only: true

  Maximum Length: 4000

  Note to supplier entered during the award process by the buyer.
• AwardPrice: number
  Read Only: true

  Price of the awarded line item.
• AwardQuantity: number
  Read Only: true

  Total quantity of line items awarded in a supplier negotiation.
• AwardStatus: string
  Read Only: true

  Maximum Length: 255

  Value that identifies whether the response was awarded or rejected.
• AwardUOM: string
  Read Only: true

  Maximum Length: 25

  Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.
• BusinessRelationship: string
  Read Only: true

  Maximum Length: 255

  Display name of the business relationship of the supplier's enterprise. Values include None, Prospective, and Spend Authorized.
• CompositeScore: number
  Read Only: true

  Sum of the weighted requirement score, and the relative pricing score that's calculated based on the total response amount provided by the supplier. The higher the composite score, the better the overall rank.
• GroupAmount: number
  Read Only: true

  Total amount quoted by the supplier bidder for the group lines.
• GroupType: string
  Read Only: true

  Maximum Length: 25

  Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.
• HasQuantityTiersFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether the line has quantity-based price tiers.
• HasScoringTeamsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether the supplier negotiation has enabled scoring teams to evaluate the requirements.
• HasShipmentsFlag: boolean
  Read Only: true

  Maximum Length: 255

  Value that indicates whether the supplier negotiation has shipment enabled for the line items.
• Line: string
  Read Only: true

  Maximum Length: 255

  Line number of the negotiation line.
• LineAmount: number
  Read Only: true

  Total amount of the line item, calculated based on the quantity.
• LineDescription: string
  Read Only: true

  Maximum Length: 2500

  Description of the negotiation line.
• LineId: integer
  Read Only: true

  Unique identifier of the negotiation line.
• LinePrice: number
  Read Only: true

  Price of the line item based on the award quantity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumRetainageAmount: number
  Read Only: true

  Maximum amount of retainage that can be withheld on a line.
• MinimumReleaseAmount: number
  Read Only: true

  Minimum release amount that the supplier quotes when responding to a negotiation with an agreement outcome.
• NoteToBuyer: string
  Read Only: true

  Maximum Length: 4000

  Note that the supplier enters for the buyer when responding to the negotiation.
• OverriddenScore: number
  Read Only: true

  New score for a given quote or score that replaces the system-computed average score.
• PartialResponseFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.
• PreviousRoundBidAndScore: string
  Read Only: true

  Maximum Length: 255

  Score of the requirements from the previous round of supplier negotiations.
• Price: number
  Read Only: true

  Price of the line item based on the award quantity.
• PromisedDeliveryDate: string (date)
  Read Only: true

  Date on which the supplier has promised to deliver the goods to the buying organization.
• PromisedShipDate: string (date)
  Read Only: true

  Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.
• Quantity: number
  Read Only: true

  Quantity of the item in the negotiation.
• Rank: integer
  Read Only: true

  The rank value displayed for the line item based on the response price.
• Response: integer
  Read Only: true

  Unique identifier of the supplier response in a supplier negotiation.
• ResponseAmount: number
  Read Only: true

  Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.
• ResponseStatusCode: string
  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the response status.
• ResponseType: string
  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the response.
• RetainageRatePercent: number
  Read Only: true

  Value that identifies the maximum percentage that can be withheld from an invoice as retainage.
• Score: number
  Read Only: true

  Value calculated by summing the scores associated with a supplier's responses to requirements specified in the negotiation.
• ScoreOverriddenFlag: boolean
  Read Only: true

  Maximum Length: 255

  Contains one of the following values: true or false. If true, then the buyer has overridden the score. If false, then the score isn't overridden.
• ShortlistFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether the corresponding bid has been shortlisted.
• Supplier: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier who responds to the negotiation.
• SupplierContact: string
  Read Only: true

  Maximum Length: 255

  Name of the supplier contact at the supplier that responds to the negotiation.
• SupplierId: integer
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Read Only: true

  Maximum Length: 30

  Unique identifier for the supplier bidder.
• SupplierSite: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer
  Read Only: true

  Value that identifies the supplier site.
• TransformedAmount: number
  Read Only: true

  Transformed bid total in buyer's currency.
• TransformedGroupAmount: number
  Read Only: true

  Total amount for the line group, including internal cost factors, as responded by the supplier bidder.
• TransformedLineAmount: number
  Read Only: true

  Total amount calculated as the quantity multiplied by the transformed price.
• TransformedLineRank: integer
  Read Only: true

  Line ranking based on the total amount for a line group, including internal cost factors, as responded by the supplier bidder.
• TransformedPrice: number
  Read Only: true

  The sum of the line price and internal cost factors applied to a supplier for that line item.
• TransformedRank: integer
  Read Only: true

  Transformed Rank for this particular bid.
• UnitPriceSavings: number
  Read Only: true

  The savings realized from one unit of the awarded line.
• UnitPriceSavingsPercent: number
  Read Only: true

  The percentage savings realized from one unit of the awarded line.
• VendorId: integer
  Read Only: true

  Value that uniquely identifies the bidder.

{
    "type":"object",
    "properties":{
        "AlternateLineDescription":{
            "maxLength":2500,
            "type":"string",
            "description":"Description of an alternate line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateLineFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if alternate lines are present in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardAmount":{
            "type":"number",
            "description":"Amount awarded to a supplier response line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardInternalNote":{
            "maxLength":4000,
            "type":"string",
            "description":"Note to the internal members entered by the buyer regarding the award decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardNoteToSupplier":{
            "maxLength":4000,
            "type":"string",
            "description":"Note to supplier entered during the award process by the buyer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardPrice":{
            "type":"number",
            "description":"Price of the awarded line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardQuantity":{
            "type":"number",
            "description":"Total quantity of line items awarded in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies whether the response was awarded or rejected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AwardUOM":{
            "maxLength":25,
            "type":"string",
            "description":"Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessRelationship":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the business relationship of the supplier's enterprise. Values include None, Prospective, and Spend Authorized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompositeScore":{
            "type":"number",
            "description":"Sum of the weighted requirement score, and the relative pricing score that's calculated based on the total response amount provided by the supplier. The higher the composite score, the better the overall rank.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupAmount":{
            "type":"number",
            "description":"Total amount quoted by the supplier bidder for the group lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GroupType":{
            "maxLength":25,
            "type":"string",
            "description":"Type of negotiation line, such as line, group, group line, lot, or lot line. A list of accepted values is defined in the lookup type PON_GROUP_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasQuantityTiersFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the line has quantity-based price tiers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasScoringTeamsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the supplier negotiation has enabled scoring teams to evaluate the requirements.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HasShipmentsFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Value that indicates whether the supplier negotiation has shipment enabled for the line items.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Line":{
            "maxLength":255,
            "type":"string",
            "description":"Line number of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineAmount":{
            "type":"number",
            "description":"Total amount of the line item, calculated based on the quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":2500,
            "type":"string",
            "description":"Description of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Unique identifier of the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinePrice":{
            "type":"number",
            "description":"Price of the line item based on the award quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumRetainageAmount":{
            "type":"number",
            "description":"Maximum amount of retainage that can be withheld on a line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumReleaseAmount":{
            "type":"number",
            "description":"Minimum release amount that the supplier quotes when responding to a negotiation with an agreement outcome.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteToBuyer":{
            "maxLength":4000,
            "type":"string",
            "description":"Note that the supplier enters for the buyer when responding to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OverriddenScore":{
            "type":"number",
            "description":"New score for a given quote or score that replaces the system-computed average score.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartialResponseFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier has submitted a partial response. A partial response means the supplier hasn't bid on all lines or is offering a lesser quantity than asked for in the negotiation line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousRoundBidAndScore":{
            "maxLength":255,
            "type":"string",
            "description":"Score of the requirements from the previous round of supplier negotiations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Price":{
            "type":"number",
            "description":"Price of the line item based on the award quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedDeliveryDate":{
            "type":"string",
            "description":"Date on which the supplier has promised to deliver the goods to the buying organization.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PromisedShipDate":{
            "type":"string",
            "description":"Date on which the supplier has promised to ship the goods to the buying organization if the Buyer Managed transportation is checked in negotiation terms.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"integer",
            "description":"The rank value displayed for the line item based on the response price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Response":{
            "type":"integer",
            "description":"Unique identifier of the supplier response in a supplier negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseAmount":{
            "type":"number",
            "description":"Total amount calculated for all line items that the supplier offered a price for when responding to a negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseStatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the response status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseType":{
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RetainageRatePercent":{
            "type":"number",
            "description":"Value that identifies the maximum percentage that can be withheld from an invoice as retainage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Score":{
            "type":"number",
            "description":"Value calculated by summing the scores associated with a supplier's responses to requirements specified in the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScoreOverriddenFlag":{
            "maxLength":255,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the buyer has overridden the score. If false, then the score isn't overridden.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShortlistFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the corresponding bid has been shortlisted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier who responds to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierContact":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier contact at the supplier that responds to the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for the supplier bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformedAmount":{
            "type":"number",
            "description":"Transformed bid total in buyer's currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformedGroupAmount":{
            "type":"number",
            "description":"Total amount for the line group, including internal cost factors, as responded by the supplier bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransformedLineAmount":{
            "type":"number",
            "description":"Total amount calculated as the quantity multiplied by the transformed price.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformedLineRank":{
            "type":"integer",
            "description":"Line ranking based on the total amount for a line group, including internal cost factors, as responded by the supplier bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TransformedPrice":{
            "type":"number",
            "description":"The sum of the line price and internal cost factors applied to a supplier for that line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransformedRank":{
            "type":"integer",
            "description":"Transformed Rank for this particular bid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPriceSavings":{
            "type":"number",
            "description":"The savings realized from one unit of the awarded line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitPriceSavingsPercent":{
            "type":"number",
            "description":"The percentage savings realized from one unit of the awarded line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bidder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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