Jump to

• Request
• Response
• Examples

Update one price break

patch

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/priceBreaks/{priceBreaksUniqID}

Request

Path Parameters

• AgreementLineId(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=
• draftPurchaseAgreementsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements to get the hash key.
• priceBreaksUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Price Breaks resource and used to uniquely identify an instance of Price Breaks. The client should not generate the hash key value. Instead, the client should query on the Price Breaks collection resource in order to navigate to a specific instance of Price Breaks to get the hash key.

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

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• DFF: array DFF
• DiscountPercent: number
  Value that identifies the discount percentage for the price break.
• EndDate: string (date)
  Date after which the price break is no longer valid for the agreement line.
• Location: string
  Title: Location

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• LocationCode: string
  Title: Name

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• LocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the item.
• Price: number
  Price of the price break.
• PriceBreakNumber: number
  Number that uniquely identifies the price break for the purchase agreement line.
• Quantity: number
  Quantity of the item on the price break.
• ReasonForChange: string
  Maximum Length: 240

  Value that identifies the reason for changing the agreement price break.
• ShipToOrganization: string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization that receives the item.
• ShipToOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization where the supplier ships the item.
• ShipToOrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization where the supplier ships the item.
• StartDate: string (date)
  Date on which the price break becomes effective for the agreement line.
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "DiscountPercent":{
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date after which the price break is no longer valid for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Location":{
            "title":"Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationCode":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Price":{
            "type":"number",
            "description":"Price of the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceBreakNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the price break for the purchase agreement line.",
            "nullable":false,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item on the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "ReasonForChange":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the reason for changing the agreement price break.",
            "nullable":true
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization that receives the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date on which the price break becomes effective for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-patch-request"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-patch-request"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-DFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : draftPurchaseAgreements-lines-priceBreaks-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : draftPurchaseAgreements-lines-priceBreaks-DFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt

{
    "type":"object",
    "properties":{
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : draftPurchaseAgreements-lines-priceBreaks-item-response

Type: object

Show Source

• AgreementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the agreement line.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• CancelFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the purchase order is canceled. If N, then the purchase order isn't canceled. This attribute doesn't have a default value.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the price breaks for a purchase agreement line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the buyer or application created the price breaks for a purchase agreement line.
• Currency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Currency on the agreement line price break.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the currency on the agreement line price break.
• DFF: array DFF
• DiscountPercent: number
  Value that identifies the discount percentage for the price break.
• EndDate: string (date)
  Date after which the price break is no longer valid for the agreement line.
• EntityChangeTypeCode: string
  Read Only: true

  Maximum Length: 1

  Value that identifies if the row is new or changed.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the price break was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the price breaks on a purchase agreement line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• LocationCode: string
  Title: Name

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• LocationId: integer (int64)
  Value that uniquely identifies the location where the supplier ships the item.
• NumberOfPriceBreakAttachments: integer (int64)
  Read Only: true

  Count of attachments associated with the price break of an agreement line.
• NumberOfPriceBreakSupplierAttachments: integer (int64)
  Read Only: true

  URL of the attachment associated with the item.
• Price: number
  Price of the price break.
• PriceBreakId: integer (int64)
  Read Only: true

  Value that uniquely identifies the price break.
• PriceBreakNumber: number
  Number that uniquely identifies the price break for the purchase agreement line.
• Quantity: number
  Quantity of the item on the price break.
• ReasonForChange: string
  Maximum Length: 240

  Value that identifies the reason for changing the agreement price break.
• ShipToOrganization: string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization that receives the item.
• ShipToOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization where the supplier ships the item.
• ShipToOrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization where the supplier ships the item.
• StartDate: string (date)
  Date on which the price break becomes effective for the agreement line.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the unit of measure on the agreement line price break.
• UOMCode: string
  Maximum Length: 3

  Code that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "AgreementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agreement line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CancelFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the purchase order is canceled. If N, then the purchase order isn't canceled. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the price breaks for a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the buyer or application created the price breaks for a purchase agreement line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency on the agreement line price break.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "DiscountPercent":{
            "type":"number",
            "description":"Value that identifies the discount percentage for the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date after which the price break is no longer valid for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EntityChangeTypeCode":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies if the row is new or changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the price break was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the price breaks on a purchase agreement line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Location":{
            "title":"Location",
            "maxLength":240,
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationCode":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "NumberOfPriceBreakAttachments":{
            "type":"integer",
            "description":"Count of attachments associated with the price break of an agreement line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "NumberOfPriceBreakSupplierAttachments":{
            "type":"integer",
            "description":"URL of the attachment associated with the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":255
            },
            "x-queryable":true
        },
        "Price":{
            "type":"number",
            "description":"Price of the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "PriceBreakId":{
            "type":"integer",
            "description":"Value that uniquely identifies the price break.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PriceBreakNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the price break for the purchase agreement line.",
            "nullable":false,
            "x-queryable":false
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of the item on the price break.",
            "nullable":true,
            "x-queryable":false
        },
        "ReasonForChange":{
            "maxLength":240,
            "type":"string",
            "description":"Value that identifies the reason for changing the agreement price break.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization that receives the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the inventory organization where the supplier ships the item.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ShipToOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "StartDate":{
            "type":"string",
            "description":"Date on which the price break becomes effective for the agreement line.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the agreement line price break.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure.",
            "nullable":true,
            "x-queryable":false
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-attachments-item-response"
    }
}

Nested Schema : DFF

Type: array

Show Source

• Array of: object draftPurchaseAgreements-lines-priceBreaks-DFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/draftPurchaseAgreements-lines-priceBreaks-DFF-item-response"
    },
    "x-cardinality":"1"
}

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 : draftPurchaseAgreements-lines-priceBreaks-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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 : draftPurchaseAgreements-lines-priceBreaks-DFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Prompt

  Maximum Length: 30

  Context Prompt
• __FLEX_Context_DisplayValue: string
  Title: Context Prompt

  Context Prompt
• LineLocationId: integer (int64)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LineLocationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "description":"Context Prompt",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/priceBreaks/{priceBreaksUniqID}/child/DFF

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID
• priceBreaksUniqID: $request.path.priceBreaksUniqID

attachments

Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/child/priceBreaks/{priceBreaksUniqID}/child/attachments

Parameters:

• AgreementLineId: $request.path.AgreementLineId
• draftPurchaseAgreementsUniqID: $request.path.draftPurchaseAgreementsUniqID
• priceBreaksUniqID: $request.path.priceBreaksUniqID

The attachments resource is used to view, create, and update attachments.

Back to Top

Examples

These examples describes how to update one price break for a blanket purchase agreement line.

Note:

Here are a few examples to update one price break on a blanket purchase agreement line:

1. Update quantity and discount one a price break
2. Update start date and end date one a cumulative price break
3. Update price break descriptive flexfields

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/draftPurchaseAgreementsUniqID/child/lines/AgreementLineId/child/priceBreaks/priceBreaksUniqID"

Examples

Table - Examples

Example Number	Description
Example 1	Update quantity and discount one a price break
Example 2	Update start date and end date one a cumulative price break
Example 3	Update price break descriptive flexfields

Example1

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109641"

Example1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "Quantity": 1500,
    "DiscountPercent": 25
}

Example1 Response Body

The following example includes the contents of the response body in JSON format:

{
    "PriceBreakId": 300100651109641,
    "PriceBreakNumber": 2,
    "AgreementLineId": 300100651109639,
    "ShipToOrganizationId": null,
    "ShipToOrganizationCode": null,
    "ShipToOrganization": null,
    "LocationId": null,
    "LocationCode": null,
    "Location": null,
    "Quantity": 1500,
    "UOMCode": "Ea",
    "UOM": "Each",
    "Price": 5.2500000000,
    "DiscountPercent": 25,
    "StartDate": null,
    "EndDate": null,
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2026-05-01T12:57:03.160+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2026-05-01T12:57:03.159+00:00",
    "NumberOfPriceBreakAttachments": 0,
    "CancelFlag": false,
    "EntityChangeTypeCode": "I",
    "ReasonForChange": null,
    "NumberOfPriceBreakSupplierAttachments": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109641",
            "name": "priceBreaks",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109641",
            "name": "priceBreaks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639",
            "name": "lines",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109641/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109641/child/attachments",
            "name": "attachments",
            "kind": "collection"
        }
    ]
}

Example 2

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643"

Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "Price": 1.25,
    "StartDate": "2026-04-15",
    "EndDate": "2026-06-15"
}

Response Body

The following example includes the contents of the response body in JSON format:

{
    "PriceBreakId": 300100651109643,
    "PriceBreakNumber": 1,
    "AgreementLineId": 300100651109642,
    "ShipToOrganizationId": null,
    "ShipToOrganizationCode": null,
    "ShipToOrganization": null,
    "LocationId": null,
    "LocationCode": null,
    "Location": null,
    "Quantity": null,
    "UOMCode": "Ea",
    "UOM": "Each",
    "Price": 1.25,
    "DiscountPercent": 37.18593,
    "StartDate": "2026-04-15",
    "EndDate": "2026-06-15",
    "CurrencyCode": "USD",
    "Currency": "US Dollar",
    "CreatedBy": "CVBUYER01",
    "CreationDate": "2026-05-01T13:01:27.024+00:00",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdateDate": "2026-05-01T13:01:27.024+00:00",
    "NumberOfPriceBreakAttachments": 0,
    "CancelFlag": false,
    "EntityChangeTypeCode": "I",
    "ReasonForChange": null,
    "NumberOfPriceBreakSupplierAttachments": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643",
            "name": "priceBreaks",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643",
            "name": "priceBreaks",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642",
            "name": "lines",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643/child/DFF",
            "name": "DFF",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643/child/attachments",
            "name": "attachments",
            "kind": "collection"
        }
    ]
}

Example 3

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643"

Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "abpTolerance": "RoHS",
     "legalEntityPoDff" : "29ABCDE1234F1Z5",
     "_PO__Document__Schedule__BI__" : "17738"
}

Response Body

The following example includes the contents of the response body in JSON format:

{
    "LineLocationId": 300100651109643,
    "_PO__Document__Schedule__BI__": "17738",
    "abpTolerance": "RoHS",
    "legalEntityPoDff": "29ABCDE1234F1Z5",
    "__FLEX_Context": null,
    "__FLEX_Context_DisplayValue": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643/child/DFF/300100651109643",
            "name": "DFF",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643/child/DFF/300100651109643",
            "name": "DFF",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109642/child/priceBreaks/300100651109643",
            "name": "priceBreaks",
            "kind": "item"
        }
    ]
}

Back to Top