Jump to

• Request
• Response

Update a line

patch

/fscmRestApi/resources/11.13.18.05/externalPurchasePrices/{HeaderId}/child/lines/{LineId}

Request

Path Parameters

• HeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• LineId(required): 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.
• InventoryItemId: integer (int64)
  Unique identifier representing the master item.
• ObjectVersionNumber: integer (int32)
  Number of times the external purchase price line has been updated.
• SelectionEnabledFlag: boolean
  Maximum Length: 1

  Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. 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.
• ValidationOrgId: integer (int64)
  Unique identifier representing the item validation organization.

{
    "type":"object",
    "properties":{
        "SelectionEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the external purchase price line has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "ValidationOrgId":{
            "type":"integer",
            "description":"Unique identifier representing the item validation organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Unique identifier representing the master item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "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 : externalPurchasePrices-lines-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.
• 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.
• HeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the external purchase prices.
• InventoryItemId: integer (int64)
  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

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

  Date when the price becomes ineffective.
• LineStartDate: string (date)
  Read Only: true

  Date when the price becomes effective.
• LineStatus: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 255

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

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

  Maximum Length: 700

  Number that uniquely identifies the manufacturer part.
• ObjectVersionNumber: integer (int32)
  Number of times the external purchase price line has been updated.
• Price: number
  Read Only: true

  Value of the unit price before adjustment.
• PurchaseAgreementFlag: 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.
• PurchaseAgreementNumber: string
  Read Only: true

  Maximum Length: 255

  Number that uniquely identifies the purchase agreement.
• PurchasingCategoryId: integer (int64)
  Read Only: true

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

  Maximum Length: 2400

  Name of the purchasing category.
• SelectionEnabledFlag: boolean
  Maximum Length: 1

  Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true.
• SupplierPartNumber: string
  Read Only: true

  Maximum Length: 300

  Number that uniquely identifies the supplier part.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

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

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• UpdateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then an unprocessed update exists for the line. If false, then there are no unprocessed updates for the line. The default value is false.
• 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.
• ValidatedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the line is validated by the Import Purchase Agreements from External Purchase Prices process. If false, then the line isn't validated. The default value is true.
• ValidationOrgId: integer (int64)
  Unique identifier representing the item validation organization.

{
    "type":"object",
    "properties":{
        "LineStatusCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies status of the external purchase price line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationOrgId":{
            "type":"integer",
            "description":"Unique identifier representing the item validation organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the external purchase prices.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "type":"integer",
            "description":"Date when the price becomes ineffective.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the external purchase price line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseAgreementNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the purchase agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurchaseAgreementFlag":{
            "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
        },
        "LineEndDate":{
            "type":"string",
            "description":"Value that uniquely identifies the external purchase price line.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then an unprocessed update exists for the line. If false, then there are no unprocessed updates for the line. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AdjustedPrice":{
            "type":"number",
            "description":"Value of the unit price after adjustment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number of times the external purchase price line has been updated.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierPartNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that uniquely identifies the supplier part.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":false,
            "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
        },
        "SelectionEnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "LineId":{
            "type":"integer",
            "description":"Number that uniquely identifies the external purchase price line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PurchasingCategoryName":{
            "maxLength":"2400",
            "type":"string",
            "description":"Name of the purchasing category.",
            "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,
            "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
        },
        "ValidatedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the line is validated by the Import Purchase Agreements from External Purchase Prices process. If false, then the line isn't validated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Value of the unit price before adjustment.",
            "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
        },
        "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":false,
            "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