Jump to

• Request
• Response

Update one external purchase price line

patch

/fscmRestApi/resources/11.13.18.05/externalPurchasePricesLines/{LineId}

Request

Path Parameters

• LineId(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=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CancelledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false.
• PurchaseEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase price line is enabled for purchasing. If false, then the external purchase price line is disabled for purchasing. The default value is true.
• UserSelectedFlag: boolean
  Maximum Length: 1

  Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.

{
    "type":"object",
    "properties":{
        "UserSelectedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.",
            "nullable":true
        },
        "PurchaseEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase price line is enabled for purchasing. If false, then the external purchase price line is disabled for purchasing. The default value is true.",
            "nullable":true
        },
        "CancelledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false.",
            "nullable":true
        }
    }
}

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 : externalPurchasePricesLines-item-response

Type: object

Show Source

• AdjustedPrice: number
  Read Only: true

  Value of the unit price after adjustment.
• AdjustmentPercentage: number
  Read Only: true

  Percent value by which the base price is adjusted.
• ApprovalStatus: string
  Read Only: true

  Maximum Length: 80

  Status of the external purchase prices.
• ApprovalStatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies status of the external purchase prices.
• BpaFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then a purchase agreement line is created for the line. If false, then a purchase agreement line isn't created for the line. The default value is false.
• CancelledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency of the external purchase prices.
• EndDate: string (date)
  Read Only: true

  Date when the external purchase prices becomes ineffective.
• ExternalPurchasePriceNumber: integer (int64)
  Read Only: true

  Number that uniquely identifies the external purchase prices.
• HeaderId: integer
  Read Only: true

  Value that uniquely identifies the external purchase prices.
• InventoryItemId: integer (int64)
  Read Only: true

  Unique identifier representing the master item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the external purchase price line record.
• LineEndDate: string (date)
  Read Only: true

  Date when the price becomes ineffective.
• LineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the external purchase price line.
• LineNumber: integer (int64)
  Read Only: true

  Number that uniquely identifies the external purchase price line.
• LineStartDate: string (date)
  Read Only: true

  Date when the price becomes effective.
• LineStatus: string
  Read Only: true

  Maximum Length: 80

  Status of the external purchase price line.
• LineStatusCode: string
  Read Only: true

  Maximum Length: 26

  Abbreviation that identifies status of the external purchase price line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManufacturerName: string
  Read Only: true

  Maximum Length: 700

  Name of the manufacturer.
• ManufacturerPartNumber: string
  Read Only: true

  Maximum Length: 700

  Number that uniquely identifies the manufacturer part.
• Price: number
  Read Only: true

  Value of the unit price before adjustment.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the procurement business unit.
• ProcurementBUName: string
  Read Only: true

  Maximum Length: 240

  Name of the procurement business unit.
• PurchaseAgreementNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase agreement.
• PurchaseEnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the external purchase price line is enabled for purchasing. If false, then the external purchase price line is disabled for purchasing. The default value is true.
• PurchasingCategoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing category.
• PurchasingCategoryName: string
  Read Only: true

  Maximum Length: 250

  Name of the purchasing category.
• RequisitioningBUId: integer
  Read Only: true

  Value that uniquely identifies the requisitioning business unit.
• RequisitioningBUName: string
  Read Only: true

  Maximum Length: 240

  Name of the requisitioning business unit.
• RequisitioningGroupId: integer (int64)
  Read Only: true

  Value that uniquely identifies a group of requisitioning business units.
• Source: string
  Read Only: true

  Maximum Length: 60

  Name of the person or organization in the source contract.
• SourceContractDescription: string
  Read Only: true

  Maximum Length: 2000

  Description of the source contract.
• SourceContractNumber: string
  Read Only: true

  Maximum Length: 120

  Number that uniquely identifies the source contract.
• SourceContractType: string
  Read Only: true

  Maximum Length: 80

  Type of the source contract.
• SourceContractTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of the source contract.
• SourceReferenceId: string
  Read Only: true

  Maximum Length: 30

  Value that uniquely identifies the external purchase prices in the source application.
• SourceType: string
  Read Only: true

  Maximum Length: 60

  Source type of the contract.
• StartDate: string (date)
  Read Only: true

  Date when the external purchase prices becomes effective.
• SupplierId: integer (int64)
  Read Only: true

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

  Maximum Length: 360

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

  Maximum Length: 30

  Number that uniquely identifies the supplier.
• SupplierPartNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the supplier part.
• SupplierSite: string
  Read Only: true

  Maximum Length: 240

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

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

  Maximum Length: 2000

  Description of the tier to which the source organization belongs.
• TierLevel: integer (int64)
  Read Only: true

  Number that indicates the tier to which the source organization belongs.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UnitOfMeasureCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UserSelectedFlag: boolean
  Maximum Length: 1

  Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.
• ValidationOrgId: integer (int64)
  Read Only: true

  Unique identifier representing the item validation organization.

{
    "type":"object",
    "properties":{
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatusCode":{
            "maxLength":"26",
            "type":"string",
            "description":"Abbreviation that identifies status of the external purchase price line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceType":{
            "maxLength":"60",
            "type":"string",
            "description":"Source type of the contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationOrgId":{
            "type":"integer",
            "description":"Unique identifier representing the item validation organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApprovalStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies status of the external purchase prices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovalStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the external purchase prices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"Status of the external purchase price line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency of the external purchase prices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the external purchase prices becomes effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustedPrice":{
            "type":"number",
            "description":"Value of the unit price after adjustment.",
            "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"
            }
        },
        "SourceReferenceId":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies the external purchase prices in the source application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierPartNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the supplier part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustmentPercentage":{
            "type":"number",
            "description":"Percent value by which the base price is adjusted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManufacturerName":{
            "maxLength":"700",
            "type":"string",
            "description":"Name of the manufacturer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchasingCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Unique identifier representing the master item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManufacturerPartNumber":{
            "maxLength":"700",
            "type":"string",
            "description":"Number that uniquely identifies the manufacturer part.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningBUName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the requisitioning business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceContractNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"Number that uniquely identifies the source contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierLevel":{
            "type":"integer",
            "description":"Number that indicates the tier to which the source organization belongs.",
            "format":"int64",
            "nullable":true,
            "readOnly":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
        },
        "Price":{
            "type":"number",
            "description":"Value of the unit price before adjustment.",
            "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
        },
        "SourceContractType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of the source contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserSelectedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalPurchasePriceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the external purchase prices.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external purchase prices.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceContractTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of the source contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceContractDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the source contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BpaFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a purchase agreement line is created for the line. If false, then a purchase agreement line isn't created for the line. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Source":{
            "maxLength":"60",
            "type":"string",
            "description":"Name of the person or organization in the source contract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the external purchase price line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchaseAgreementNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineEndDate":{
            "type":"string",
            "description":"Date when the price becomes ineffective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CancelledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase prices are canceled. If false, then the external purchase prices are active. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external purchase price line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchaseEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the external purchase price line is enabled for purchasing. If false, then the external purchase price line is disabled for purchasing. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "PurchasingCategoryName":{
            "maxLength":"250",
            "type":"string",
            "description":"Name of the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that uniquely identifies the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the external purchase prices becomes ineffective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the tier to which the source organization belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitioningGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies a group of requisitioning business units.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineStartDate":{
            "type":"string",
            "description":"Date when the price becomes effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the external purchase price line record.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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