Jump to

• Request
• Response

Update one business unit access entry for the purchase agreement

patch

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

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

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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.
• 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.
• 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
            }
        },
        "BidNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies a negotiation response.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "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"
            }
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Unique identifier of the bill-to location in the business unit access.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Value that indicates whether the current organization assignment for the agreement is enabled.",
            "nullable":true
        },
        "LocationCode":{
            "title":"Bill-to Location",
            "maxLength":60,
            "type":"string",
            "description":"Code of the Location.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "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
        },
        "POSequenceNumber":{
            "type":"number",
            "description":"Sequence number of the purchase agreement.",
            "nullable":false
        },
        "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
            }
        },
        "SequenceNumber":{
            "type":"number",
            "description":"Display sequence of the staged purchasing documents or purchasing documents within a negotiation.",
            "nullable":false
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VendorSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Back to Top