Jump to

• Request
• Response

Get one supplier negotiation

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationContracts/{AuctionHeaderId}

Request

Path Parameters

• AuctionHeaderId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: 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 : supplierNegotiationContracts-item-response

Type: object

Show Source

• AmendmentNumber: number
  Title: Amendment

  Read Only: true

  Indicates the amendment number.
• AuctionHeaderId: integer (int64)
  Read Only: true

  Unique identifier for the negotiation.
• AuctionStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 25

  Indicates the status of the auction.
• AuctionTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 80

  Indicates the auction title.
• AwardStatus: string
  Read Only: true

  Maximum Length: 25

  Status of the negotiation award.
• CarrierId: integer (int64)
  Read Only: true

  Unique identifier for the carrier.
• ContractId: integer (int64)
  Read Only: true

  Unique identifier of the supplier contract.
• ContractTemplateId: number
  Read Only: true

  Unique identifier of the contracts template.
• ContractType: string
  Title: Outcome

  Read Only: true

  Maximum Length: 25

  Name of the contract type.
• DocumentNumber: string
  Title: Negotiation

  Read Only: true

  Maximum Length: 240

  Number of the negotiation document.
• FOBCode: string
  Title: FOB

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the point or location where the ownership of the items and services, and the cost of damage or loss, transfers from the supplier to the buyer.
• FreightTermsCode: string
  Title: Freight Terms

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the name of the terms that determine whether the buyer or supplier pays freight charges for items and services.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Number that indicates the version of the row.
• PaymentTermsId: integer (int64)
  Title: Payment Terms

  Read Only: true

  Value that uniquely identifies the name of the payment terms the supplier applies when making the sale, based on the invoice due date and discount date.
• POMinimumReleaseAmount: number
  Title: Minimum Release Amount

  Read Only: true

  Indicates the purchase order minimum release amount.
• supplierContracts: array Supplier Contracts
  Title: Supplier Contracts

  Supplier contracts generated from negotiation events, such as requests for quotations or auctions, when the finalized award outcome specifies the creation of a supplier contract.

{
    "type":"object",
    "properties":{
        "AmendmentNumber":{
            "title":"Amendment",
            "type":"number",
            "description":"Indicates the amendment number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AuctionStatus":{
            "title":"Status",
            "maxLength":25,
            "type":"string",
            "description":"Indicates the status of the auction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuctionTitle":{
            "title":"Title",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the auction title.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardStatus":{
            "maxLength":25,
            "type":"string",
            "description":"Status of the negotiation award.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierId":{
            "type":"integer",
            "description":"Unique identifier for the carrier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Unique identifier of the supplier contract.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractTemplateId":{
            "type":"number",
            "description":"Unique identifier of the contracts template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractType":{
            "title":"Outcome",
            "maxLength":25,
            "type":"string",
            "description":"Name of the contract type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentNumber":{
            "title":"Negotiation",
            "maxLength":240,
            "type":"string",
            "description":"Number of the negotiation document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FOBCode":{
            "title":"FOB",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the point or location where the ownership of the items and services, and the cost of damage or loss, transfers from the supplier to the buyer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FreightTermsCode":{
            "title":"Freight Terms",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the name of the terms that determine whether the buyer or supplier pays freight charges for items and services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that indicates the version of the row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "POMinimumReleaseAmount":{
            "title":"Minimum Release Amount",
            "type":"number",
            "description":"Indicates the purchase order minimum release amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTermsId":{
            "title":"Payment Terms",
            "type":"integer",
            "description":"Value that uniquely identifies the name of the payment terms the supplier applies when making the sale, based on the invoice due date and discount date.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "supplierContracts":{
            "title":"Supplier Contracts",
            "type":"array",
            "description":"Supplier contracts generated from negotiation events, such as requests for quotations or auctions, when the finalized award outcome specifies the creation of a supplier contract.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationContracts-supplierContracts-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 : Supplier Contracts

Type: array

Title: Supplier Contracts

Supplier contracts generated from negotiation events, such as requests for quotations or auctions, when the finalized award outcome specifies the creation of a supplier contract.

Show Source

• Array of: object supplierNegotiationContracts-supplierContracts-item-response

{
    "title":"Supplier Contracts",
    "type":"array",
    "description":"Supplier contracts generated from negotiation events, such as requests for quotations or auctions, when the finalized award outcome specifies the creation of a supplier contract.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationContracts-supplierContracts-item-response"
    }
}

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."
        }
    }
}

Nested Schema : supplierNegotiationContracts-supplierContracts-item-response

Type: object

Show Source

• AuctionHeaderId: integer
  Read Only: true

  Unique identifier for the negotiation.
• ContractClass: string
  Read Only: true

  Maximum Length: 30

  Class of the contract.
• ContractId: integer (int64)
  Read Only: true

  Unique identifier for the supplier contract.
• ContractLinesCount: number
  Read Only: true

  Count of lines present in the supplier contract.
• ContractNumber: string
  Read Only: true

  Maximum Length: 120

  Number of the contract document.
• ContractType: string
  Read Only: true

  Maximum Length: 150

  Name of the contract type.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code for the currency of the contract
• EndDate: string (date)
  Read Only: true

  End date on the supplier contract.
• links: array Links
  Title: Links

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

  Order amount on the supplier contract.
• ResponseNumber: integer (int64)
  Read Only: true

  Unique identifier for the response.
• StartDate: string (date)
  Read Only: true

  Start date on the supplier contract.
• Status: string
  Read Only: true

  Maximum Length: 80

  Status of the supplier contract.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code for the status of the contract.
• SupplierName: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier.
• SupplierSite: string
  Read Only: true

  Maximum Length: 240

  Name of the supplier site.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractClass":{
            "maxLength":30,
            "type":"string",
            "description":"Class of the contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Unique identifier for the supplier contract.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractLinesCount":{
            "type":"number",
            "description":"Count of lines present in the supplier contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Number of the contract document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractType":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the contract type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code for the currency of the contract",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date on the supplier contract.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderedAmount":{
            "type":"number",
            "description":"Order amount on the supplier contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumber":{
            "type":"integer",
            "description":"Unique identifier for the response.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date on the supplier contract.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the supplier contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code for the status of the contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier.",
            "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
        },
        "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"
    }
}

Links

CreateSupplierContracts

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiationContracts/{AuctionHeaderId}/action/CreateSupplierContracts

Parameters:

• AuctionHeaderId: $request.path.AuctionHeaderId

Creates a supplier contract from a finalized award when the award outcome specifies the creation of a supplier contract.

supplierContracts

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiationContracts/{AuctionHeaderId}/child/supplierContracts

Parameters:

• AuctionHeaderId: $request.path.AuctionHeaderId

Supplier contracts generated from negotiation events, such as requests for quotations or auctions, when the finalized award outcome specifies the creation of a supplier contract.

Back to Top