Jump to

• Request
• Response

Get one negotiation detail

get

/fscmRestApi/resources/11.13.18.05/supplierNegotiationPurchasingDocuments/{AuctionHeaderId}/child/purchasingDocuments/{purchasingDocumentsUniqID}

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=
• purchasingDocumentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- ResponseNumber and SequenceNumber ---for the Purchasing Documents resource and used to uniquely identify an instance of Purchasing Documents. The client should not generate the hash key value. Instead, the client should query on the Purchasing Documents collection resource with a filter on the primary key values in order to navigate to a specific instance of Purchasing Documents.
  
  For example: purchasingDocuments?q=ResponseNumber=<value1>;SequenceNumber=<value2>

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 : supplierNegotiationPurchasingDocuments-purchasingDocuments-item-response

Type: object

Show Source

• AcknowledgeWithinDays: number
  Title: Acknowledgment Within Days

  Value that specifies the deadline by which a supplier must acknowledge the document to the buyer.
• AgreementAmount: number
  Title: Purchasing Document Amount

  Read Only: true

  Total amount on the purchase agreement.
• agreementBusinessUnitAccesses: array Business Unit Access for Purchase Agreements
  Title: Business Unit Access for Purchase Agreements

  Business Unit Access for Purchase Agreements
• AgreementEndDate: string (date)
  Title: Agreement End Date

  Date when the purchase agreement expires.
• AgreementStartDate: string (date)
  Title: Agreement Start Date

  Date when the purchase agreement goes into effect.
• AuctionHeaderId: integer (int64)
  Value that uniquely identifies a negotiation.
• AutomaticallyGenerateOrdersFlag: boolean
  Title: Automatically generate orders

  Maximum Length: 1

  Value that indicates whether to automatically generate orders for the agreement.
• AutomaticallySubmitForApprovalFlag: boolean
  Title: Automatically submit for approval

  Maximum Length: 1

  Value that indicates whether to automatically submit the agreement for approval.
• awardedLines: array Awarded Lines for Purchase Agreements
  Title: Awarded Lines for Purchase Agreements

  Details about the awarded lines in a purchasing document.
• BilltoBU: string
  Title: Bill-to BU

  Read Only: true

  Maximum Length: 240

  Name of the bill-to business unit for an agreement.
• BilltoBUId: integer (int64)
  Unique identifier of the bill-to business unit that vouches for the supplier invoices received for the purchase order.
• BillToLocation: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  Name of the bill-to location in the business unit access.
• BillToLocationId: integer (int64)
  Unique identifier of the bill-to location in the business unit access.
• Buyer: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the user who created the negotiation.
• BuyerId: integer (int64)
  Value that uniquely identifies the user who created the negotiation.
• CommunicateRepricedOrdersFlag: boolean
  Maximum Length: 1

  Value that finds a negotiation using the supplier site as the primary key.
• ContractId: integer (int64)
  Read Only: true

  Unique identifier that represents a contract.
• ContractType: string
  Title: Outcome

  Read Only: true

  Maximum Length: 25

  Value that uniquely identifies the contract type for the short-term or long-term purchase.
• DisplayInitiateApprovalFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether to display the text Initiate Approval.
• DocumentFiscalClassification: string
  Read Only: true

  Maximum Length: 1996

  Value that uniquely identifies the document's fiscal classification.
• ExistingAgreementMatchingLineActionType: string
  Maximum Length: 30

  Indicates if matching lines from an existing purchasing document need to be expired, updated, or added.
• GroupRequisitionsFlag: boolean
  Title: Group requisitions

  Maximum Length: 1

  Value that indicates whether to group requisitions for the agreement.
• GroupRequisitionsLinesFlag: boolean
  Title: Group requisition lines

  Maximum Length: 1

  Value that indicates whether to group requisition lines for the agreement.
• HasPendingChangeOrder: string
  Read Only: true

  Maximum Length: 1

  Value that indicates whether a purchasing document has a pending change order.
• InitiateApprovalFlag: boolean
  Title: Initiate Approval

  Maximum Length: 1

  Value that indicates whether to initiate approval for a purchasing document.
• IsSupplierSiteEditableFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates if the supplier site is editable or read-only for a staged purchasing document.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfAwardedLines: integer
  Read Only: true

  Number of awarded lines in a staged purchasing document.
• PricePrecision: integer (int32)
  Title: Precision

  Read Only: true

  Indicates the accuracy (number of decimal places) with which the price values will be displayed in the award.
• ProcurementBUId: integer (int64)
  Title: Procurement BU

  Read Only: true

  Value that uniquely identifies the procurement business unit that owns the negotiation.
• ProgressPaymentFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that uniquely identifies the procurement business unit that owns the negotiation.
• PurchasingDocumentHeaderId: integer (int64)
  Read Only: true

  Value to uniquely identify a purchasing document.
• PurchasingDocumentNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that identifies a purchasing document.
• PurchasingDocumentStatus: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Status of the purchasing document.
• PurchasingDocumentStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the status of the purchasing document.
• RelationshipId: integer (int64)
  Read Only: true

  Value to uniquely identify the relationship of the supplier contact.
• RepriceOpenOrdersOnlyFlag: boolean
  Maximum Length: 1

  Value that uniquely identifies the relationship between the supplier contact and the supplier.
• RequiredAcknowledgement: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Acknowledgment required by the application from the supplier. Values include: Document and Schedule when the supplier must acknowledge the header and line of the purchase agreement, Document when the supplier must acknowledge the header of the purchase agreement, or None when the purchase agreement doesn't require acknowledgment.
• RequiredAcknowledgementCode: string
  Title: Required Acknowledgment

  Maximum Length: 1

  Abbreviation identifying the acknowledgment required from the supplier for the purchase order. Values include: Y (Document and Schedule), D (Document), and N (None).
• RequisitioningBU: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  Name of the requisitioning business unit.
• RequisitioningBUId: integer (int64)
  Unique identifier of the requisitioning business unit in business unit access.
• ResponseCurrencyCode: string
  Title: Response Currency

  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency that the response uses.
• ResponseNumber: integer (int64)
  Title: Response

  Read Only: true

  Uniquely identifies supplier's response for a negotiation.
• SequenceNumber: number
  Display sequence of the staged purchasing documents or purchasing documents within a negotiation.
• SoldtoLeId: integer (int64)
  Unique identifier of the party financially responsible for purchases on a purchase order.
• SoldToLEName: string
  Title: Legal Entity Name

  Read Only: true

  Maximum Length: 240

  Indicates the party financially responsible for the purchases on a purchase order.
• Supplier: string
  Title: Name

  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.
• SupplierContactId: integer (int64)
  Value that uniquely identifies the supplier contact.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Name of the supplier site.
• SupplierSiteId: integer (int64)
  Title: Supplier Site

  Value that identifies the supplier site.
• TerritoryShortName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 80

  Name of the country where the transaction is deemed to have taken place for taxation purposes.
• TotalAgreementAmount: number
  Title: Award Amount

  Read Only: true

  The total amount of all lines in the purchase agreement.
• TotalAgreementAmountResponseCurrency: number
  Read Only: true

  Total agreement amount of a purchasing document in the response currency.
• TotalAwardAmount: number
  Read Only: true

  The total amount awarded to the supplier response.
• TotalAwardAmountResponseCurrency: number
  Read Only: true

  Total award amount of a purchasing document in the response currency.
• UpdateExistingAgreementFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value that indicates whether updating an existing agreement from a sourcing award is enabled.
• UsePurchasingDocumentHeaderId: integer (int64)
  Value that uniquely identifies a purchasing document to which the awarded lines should be added.
• UseRequestedDateFlag: boolean
  Maximum Length: 1

  Value that indicates whether to group requisition lines by using the requested date for the agreement.
• UseShipToOrganizationAndLocationFlag: boolean
  Maximum Length: 1

  Group requisition lines using ship to organization and location.
• VendorId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.

{
    "type":"object",
    "properties":{
        "AcknowledgeWithinDays":{
            "title":"Acknowledgment Within Days",
            "type":"number",
            "description":"Value that specifies the deadline by which a supplier must acknowledge the document to the buyer.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementAmount":{
            "title":"Purchasing Document Amount",
            "type":"number",
            "description":"Total amount on the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementEndDate":{
            "title":"Agreement End Date",
            "type":"string",
            "description":"Date when the purchase agreement expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementStartDate":{
            "title":"Agreement Start Date",
            "type":"string",
            "description":"Date when the purchase agreement goes into effect.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AutomaticallyGenerateOrdersFlag":{
            "title":"Automatically generate orders",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to automatically generate orders for the agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "AutomaticallySubmitForApprovalFlag":{
            "title":"Automatically submit for approval",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to automatically submit the agreement for approval.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToLocation":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Name of the bill-to location in the business unit access.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the bill-to location in the business unit access.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BilltoBU":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "description":"Name of the bill-to business unit for an agreement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BilltoBUId":{
            "type":"integer",
            "description":"Unique identifier of the bill-to business unit that vouches for the supplier invoices received for the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Buyer":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the user who created the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who created the negotiation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CommunicateRepricedOrdersFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that finds a negotiation using the supplier site as the primary key.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Unique identifier that represents a contract.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractType":{
            "title":"Outcome",
            "maxLength":25,
            "type":"string",
            "description":"Value that uniquely identifies the contract type for the short-term or long-term purchase.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayInitiateApprovalFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to display the text Initiate Approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentFiscalClassification":{
            "maxLength":1996,
            "type":"string",
            "description":"Value that uniquely identifies the document's fiscal classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExistingAgreementMatchingLineActionType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if matching lines from an existing purchasing document need to be expired, updated, or added.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupRequisitionsFlag":{
            "title":"Group requisitions",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to group requisitions for the agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupRequisitionsLinesFlag":{
            "title":"Group requisition lines",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to group requisition lines for the agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "HasPendingChangeOrder":{
            "maxLength":1,
            "type":"string",
            "description":"Value that indicates whether a purchasing document has a pending change order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InitiateApprovalFlag":{
            "title":"Initiate Approval",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to initiate approval for a purchasing document.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSupplierSiteEditableFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates if the supplier site is editable or read-only for a staged purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfAwardedLines":{
            "type":"integer",
            "description":"Number of awarded lines in a staged purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricePrecision":{
            "title":"Precision",
            "type":"integer",
            "description":"Indicates the accuracy (number of decimal places) with which the price values will be displayed in the award.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "ProcurementBUId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit that owns the negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "ProgressPaymentFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that uniquely identifies the procurement business unit that owns the negotiation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PurchasingDocumentHeaderId":{
            "type":"integer",
            "description":"Value to uniquely identify a purchasing document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PurchasingDocumentNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies a purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchasingDocumentStatus":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchasingDocumentStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the purchasing document.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "type":"integer",
            "description":"Value to uniquely identify the relationship of the supplier contact.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RepriceOpenOrdersOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that uniquely identifies the relationship between the supplier contact and the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredAcknowledgement":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Acknowledgment required by the application from the supplier. Values include: Document and Schedule when the supplier must acknowledge the header and line of the purchase agreement, Document when the supplier must acknowledge the header of the purchase agreement, or None when the purchase agreement doesn't require acknowledgment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredAcknowledgementCode":{
            "title":"Required Acknowledgment",
            "maxLength":1,
            "type":"string",
            "description":"Abbreviation identifying the acknowledgment required from the supplier for the purchase order. Values include: Y (Document and Schedule), D (Document), and N (None).",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitioningBU":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Unique identifier of the requisitioning business unit in business unit access.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the response uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumber":{
            "title":"Response",
            "type":"integer",
            "description":"Uniquely identifies supplier's response for a negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"Display sequence of the staged purchasing documents or purchasing documents within a negotiation.",
            "nullable":false,
            "x-queryable":true
        },
        "SoldToLEName":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Indicates the party financially responsible for the purchases on a purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldtoLeId":{
            "type":"integer",
            "description":"Unique identifier of the party financially responsible for purchases on a purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Supplier":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier who responds to the negotiation.",
            "nullable":false,
            "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
        },
        "SupplierContactId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site",
            "type":"integer",
            "description":"Value that identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerritoryShortName":{
            "title":"Territory Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the country where the transaction is deemed to have taken place for taxation purposes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAgreementAmount":{
            "title":"Award Amount",
            "type":"number",
            "description":"The total amount of all lines in the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAgreementAmountResponseCurrency":{
            "type":"number",
            "description":"Total agreement amount of a purchasing document in the response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAwardAmount":{
            "type":"number",
            "description":"The total amount awarded to the supplier response.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAwardAmountResponseCurrency":{
            "type":"number",
            "description":"Total award amount of a purchasing document in the response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateExistingAgreementFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether updating an existing agreement from a sourcing award is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UsePurchasingDocumentHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a purchasing document to which the awarded lines should be added.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UseRequestedDateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether to group requisition lines by using the requested date for the agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "UseShipToOrganizationAndLocationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Group requisition lines using ship to organization and location.",
            "nullable":true,
            "x-queryable":true
        },
        "VendorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "agreementBusinessUnitAccesses":{
            "title":"Business Unit Access for Purchase Agreements",
            "type":"array",
            "description":"Business Unit Access for Purchase Agreements",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationPurchasingDocuments-purchasingDocuments-agreementBusinessUnitAccesses-item-response"
            }
        },
        "awardedLines":{
            "title":"Awarded Lines for Purchase Agreements",
            "type":"array",
            "description":"Details about the awarded lines in a purchasing document.",
            "items":{
                "$ref":"#/components/schemas/supplierNegotiationPurchasingDocuments-purchasingDocuments-awardedLines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Business Unit Access for Purchase Agreements

Type: array

Title: Business Unit Access for Purchase Agreements

Business Unit Access for Purchase Agreements

Show Source

• Array of: object supplierNegotiationPurchasingDocuments-purchasingDocuments-agreementBusinessUnitAccesses-item-response

{
    "title":"Business Unit Access for Purchase Agreements",
    "type":"array",
    "description":"Business Unit Access for Purchase Agreements",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationPurchasingDocuments-purchasingDocuments-agreementBusinessUnitAccesses-item-response"
    }
}

Nested Schema : Awarded Lines for Purchase Agreements

Type: array

Title: Awarded Lines for Purchase Agreements

Details about the awarded lines in a purchasing document.

Show Source

• Array of: object supplierNegotiationPurchasingDocuments-purchasingDocuments-awardedLines-item-response

{
    "title":"Awarded Lines for Purchase Agreements",
    "type":"array",
    "description":"Details about the awarded lines in a purchasing document.",
    "items":{
        "$ref":"#/components/schemas/supplierNegotiationPurchasingDocuments-purchasingDocuments-awardedLines-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 : supplierNegotiationPurchasingDocuments-purchasingDocuments-agreementBusinessUnitAccesses-item-response

Type: object

Show Source

• AuctionHeaderId: integer (int64)
  Value that uniquely identifies a negotiation.
• BidNumber: integer (int64)
  Value that uniquely identifies a negotiation response.
• BilltoBUId: integer (int64)
  Unique identifier of the bill-to business unit that vouches for the supplier invoices received for the purchase order.
• BillToBUName: string
  Title: Bill-to BU

  Maximum Length: 240

  Name of the bill-to business unit for an agreement.
• BillToLocationId: integer (int64)
  Unique identifier of the bill-to location in the business unit access.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Value that indicates whether the current organization assignment for the agreement is enabled.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationCode: string
  Title: Bill-to Location

  Maximum Length: 60

  Code of the Location.
• OrderedLocallyFlag: boolean
  Title: Order Locally

  Maximum Length: 1

  Indicates whether the client's order for items on the agreement should be routed to local supplier sites maintained by the client.
• POSequenceNumber: number
  Sequence number of the purchase agreement.
• PurchasingSiteName: string
  Title: Purchasing Site

  Read Only: true

  Name of the supplier site enabled for purchasing.
• RequisitioningBU: string
  Title: Requisitioning BU

  Read Only: true

  Name of the requisitioning business unit.
• RequisitioningBUId: integer (int64)
  Title: Requisitioning BU

  Unique identifier of the requisitioning business unit in business unit access.
• SequenceNumber: number
  Display sequence of the staged purchasing documents or purchasing documents within a negotiation.
• ShipToLocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the item.
• ShipToLocationName: string
  Title: Ship-to Location

  Read Only: true

  Name of the location where the application ships the negotiated item, or where the provider performs the negotiated service.
• VendorSiteCode: string
  Title: Site

  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the supplier site code.
• VendorSiteId: integer (int64)
  Value that uniquely identifies the supplier site.

{
    "type":"object",
    "properties":{
        "AuctionHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BidNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BillToBUName":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "description":"Name of the bill-to business unit for an agreement.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Bill-to BU"
                },
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the bill-to location in the business unit access.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BilltoBUId":{
            "type":"integer",
            "description":"Unique identifier of the bill-to business unit that vouches for the supplier invoices received for the purchase order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the current organization assignment for the agreement is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationCode":{
            "title":"Bill-to Location",
            "maxLength":60,
            "type":"string",
            "description":"Code of the Location.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OrderedLocallyFlag":{
            "title":"Order Locally",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the client's order for items on the agreement should be routed to local supplier sites maintained by the client.",
            "nullable":true,
            "x-queryable":true
        },
        "POSequenceNumber":{
            "type":"number",
            "description":"Sequence number of the purchase agreement.",
            "nullable":false,
            "x-queryable":true
        },
        "PurchasingSiteName":{
            "title":"Purchasing Site",
            "type":"string",
            "description":"Name of the supplier site enabled for purchasing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "title":"Requisitioning BU",
            "type":"integer",
            "description":"Unique identifier of the requisitioning business unit in business unit access.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"Display sequence of the staged purchasing documents or purchasing documents within a negotiation.",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocationName":{
            "title":"Ship-to Location",
            "type":"string",
            "description":"Name of the location where the application ships the negotiated item, or where the provider performs the negotiated service.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "VendorSiteCode":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Value that uniquely identifies the supplier site code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

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 : supplierNegotiationPurchasingDocuments-purchasingDocuments-awardedLines-item-response

Type: object

Show Source

• AgreementLineAmount: number
  Read Only: true

  Value that finds a negotiation using the supplier site as the primary key.
• AgreementLineAmountResponseCurrency: number
  Read Only: true

  Value that finds a negotiation using the supplier site as the primary key.
• AlternateLineDescription: string
  Title: Alternate Line Description

  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 (int64)
  Value that uniquely identifies a negotiation.
• CategoryName: string
  Read Only: true

  Maximum Length: 2400

  Name of the purchasing category.
• Description: string
  Title: Description

  Maximum Length: 2500

  Description of the awarded line item.
• ItemId: integer (int64)
  Unique identifier for the item.
• ItemRevision: string
  Title: Revision

  Maximum Length: 18

  Item revision associated to the purchase order line.
• LineNumber: number
  Line number in a supplier response.
• LinePriceResponseCurrency: number
  Read Only: true

  Price of the negotiation line item in response currency.
• LineTypeLookupCode: string
  Read Only: true

  Maximum Length: 25

  Value that finds a negotiation using the supplier site as the primary key.
• links: array Links
  Title: Links

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

  Total amount ordered for the purchase order line.
• OrderLineAmountResponseCurrency: number
  Read Only: true

  Total amount ordered for the purchase order line in response currency.
• OrderLineItemNumber: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the item number of a purchase order line.
• PricePrecision: integer (int32)
  Title: Precision

  Read Only: true

  Indicates the accuracy (number of decimal places) with which the price values will be displayed in the award.
• PromisedDeliveryDate: string (date)
  Title: Promised Delivery Date

  Read Only: true

  Date on which the supplier has promised to deliver the goods to the buying organization.
• PromisedShipDate: string (date)
  Title: Promised Ship 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
  Quantity of the item in the negotiation.
• Requisition: string
  Title: Requisition

  Read Only: true

  Maximum Length: 64

  Requisition number that the negotiation line references.
• RequisitioningBUId: integer (int64)
  Read Only: true

  Unique identifier of the requisitioning business unit in business unit access.
• RequisitionLine: string
  Read Only: true

  Maximum Length: 20

  Requisition line number that the negotiation line references.
• ResponseCurrencyCode: string
  Title: Response Currency

  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency that the response uses.
• ResponseNumber: integer (int64)
  Read Only: true

  Uniquely identifies supplier's response for a negotiation.
• SequenceNumber: number
  Display sequence of the staged purchasing documents or purchasing documents within a negotiation.
• StagedDocumentDisplayLineNumber: string
  Title: Line

  Read Only: true

  Maximum Length: 25

  Display line number for a negotiation line in a staged purchasing document.
• SupplierItem: string
  Read Only: true

  Maximum Length: 150

  Name of the item in the supplier company.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure for the item in the negotiation.
• UnitPrice: number
  Read Only: true

  Price per unit in negotiation currency.

{
    "type":"object",
    "properties":{
        "AgreementLineAmount":{
            "type":"number",
            "description":"Value that finds a negotiation using the supplier site as the primary key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgreementLineAmountResponseCurrency":{
            "type":"number",
            "description":"Value that finds a negotiation using the supplier site as the primary key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateLineDescription":{
            "title":"Alternate Line Description",
            "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 a negotiation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":2400,
            "type":"string",
            "description":"Name of the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2500,
            "type":"string",
            "description":"Description of the awarded line item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier for the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemRevision":{
            "title":"Revision",
            "maxLength":18,
            "type":"string",
            "description":"Item revision associated to the purchase order line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Line number in a supplier response.",
            "nullable":false,
            "x-queryable":true
        },
        "LinePriceResponseCurrency":{
            "type":"number",
            "description":"Price of the negotiation line item in response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeLookupCode":{
            "maxLength":25,
            "type":"string",
            "description":"Value that finds a negotiation using the supplier site as the primary key.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineAmount":{
            "type":"number",
            "description":"Total amount ordered for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineAmountResponseCurrency":{
            "type":"number",
            "description":"Total amount ordered for the purchase order line in response currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderLineItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the item number of a purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricePrecision":{
            "title":"Precision",
            "type":"integer",
            "description":"Indicates the accuracy (number of decimal places) with which the price values will be displayed in the award.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PromisedDeliveryDate":{
            "title":"Promised Delivery Date",
            "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":true
        },
        "PromisedShipDate":{
            "title":"Promised Ship Date",
            "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,
            "x-queryable":true
        },
        "Requisition":{
            "title":"Requisition",
            "maxLength":64,
            "type":"string",
            "description":"Requisition number that the negotiation line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionLine":{
            "maxLength":20,
            "type":"string",
            "description":"Requisition line number that the negotiation line references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Unique identifier of the requisitioning business unit in business unit access.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseCurrencyCode":{
            "title":"Response Currency",
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency that the response uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseNumber":{
            "type":"integer",
            "description":"Uniquely identifies supplier's response for a negotiation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"number",
            "description":"Display sequence of the staged purchasing documents or purchasing documents within a negotiation.",
            "nullable":false,
            "x-queryable":true
        },
        "StagedDocumentDisplayLineNumber":{
            "title":"Line",
            "maxLength":25,
            "type":"string",
            "description":"Display line number for a negotiation line in a staged purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierItem":{
            "maxLength":150,
            "type":"string",
            "description":"Name of the item in the supplier company.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item in the negotiation.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Price per unit in negotiation currency.",
            "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

agreementBusinessUnitAccesses

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiationPurchasingDocuments/{AuctionHeaderId}/child/purchasingDocuments/{purchasingDocumentsUniqID}/child/agreementBusinessUnitAccesses

Parameters:

• AuctionHeaderId: $request.path.AuctionHeaderId
• purchasingDocumentsUniqID: $request.path.purchasingDocumentsUniqID

Business Unit Access for Purchase Agreements

awardedLines

Operation: /fscmRestApi/resources/11.13.18.05/supplierNegotiationPurchasingDocuments/{AuctionHeaderId}/child/purchasingDocuments/{purchasingDocumentsUniqID}/child/awardedLines

Parameters:

• AuctionHeaderId: $request.path.AuctionHeaderId
• purchasingDocumentsUniqID: $request.path.purchasingDocumentsUniqID

Details about the awarded lines in a purchasing document.

Back to Top