Create price breaks
/fscmRestApi/resources/11.13.18.05/purchaseAgreementImportRequests/{InterfaceHeaderId}/child/lines/{InterfaceLineId}/child/priceBreaks
Request
-
InterfaceHeaderId(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=
-
InterfaceLineId(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=
-
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.
- application/json
object
-
Attribute1: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute10: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute11: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute12: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute13: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute14: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute15: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute16: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute17: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute18: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute19: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute2: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute20: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute3: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute4: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute5: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute6: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute7: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute8: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute9: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeCategory: string
Maximum Length:
30
Category segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeDate1: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate10: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate2: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate3: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate4: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate5: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate6: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate7: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate8: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate9: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber1: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber10: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber2: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber3: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber4: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber5: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber6: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber7: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber8: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber9: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp1: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp10: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp2: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp3: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp4: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp5: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp6: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp7: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp8: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp9: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
DiscountPercent: number
Title:
Discount Percent
Value that identifies the discount percentage for the price break. -
EndDate: string
(date)
Date after which the purchase agreement is no longer valid.
-
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the agreement line interface price break. -
InterfaceLineLocationId: integer
(int64)
Value that uniquely identifies the agreement line interface price break.
-
InterfaceLineLocationKey: string
Maximum Length:
50
Value that uniquely identifies the price break record and is unique for the load request. -
Price: number
Title:
Price
Unit price for the line. -
PriceBreakNumber: number
Title:
Price Break
Value that uniquely identifies the price break referenced by this line. -
Quantity: number
Title:
Quantity
Value that identifies the price break quantity, when the price break is effective for blanket purchase orders. -
ShipToLocation: string
Maximum Length:
60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
-
ShipToOrganizationCode: string
Title:
Ship-to Organization Code
Maximum Length:18
Name of the inventory organization that receives the item. -
ShipToOrganizationId: integer
(int64)
Value that uniquely identifies the ship-to organization.
-
StartDate: string
(date)
Date on which the agreement becomes effective.
Response
- application/json
Default Response
-
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.
object
-
Attribute1: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute10: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute11: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute12: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute13: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute14: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute15: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute16: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute17: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute18: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute19: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute2: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute20: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute3: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute4: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute5: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute6: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute7: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute8: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
Attribute9: string
Maximum Length:
150
Segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeCategory: string
Maximum Length:
30
Category segment for the purchase agreement line price breaks descriptive flexfield. -
AttributeDate1: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate10: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate2: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate3: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate4: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate5: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate6: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate7: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate8: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeDate9: string
(date)
Date segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber1: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber10: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber2: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber3: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber4: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber5: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber6: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber7: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber8: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeNumber9: number
Number segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp1: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp10: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp2: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp3: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp4: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp5: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp6: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp7: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp8: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
AttributeTimestamp9: string
(date-time)
Date and time segment for the purchase agreement line price breaks descriptive flexfield.
-
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. -
DiscountPercent: number
Title:
Discount Percent
Value that identifies the discount percentage for the price break. -
EndDate: string
(date)
Date after which the purchase agreement is no longer valid.
-
InterfaceHeaderId: integer
(int64)
Value that uniquely identifies the interface header.
-
InterfaceLineId: integer
(int64)
Value that uniquely identifies the interface line.
-
InterfaceLineKey: string
Maximum Length:
50
Value that uniquely identifies the agreement line interface price break. -
InterfaceLineLocationId: integer
(int64)
Value that uniquely identifies the agreement line interface price break.
-
InterfaceLineLocationKey: string
Maximum Length:
50
Value that uniquely identifies the price break record and is unique for the load request. -
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. -
Price: number
Title:
Price
Unit price for the line. -
PriceBreakNumber: number
Title:
Price Break
Value that uniquely identifies the price break referenced by this line. -
ProcessCode: string
Read Only:
true
Maximum Length:25
Value that uniquely identifies the interface record status. -
Quantity: number
Title:
Quantity
Value that identifies the price break quantity, when the price break is effective for blanket purchase orders. -
ShipToLocation: string
Maximum Length:
60
Name of the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
-
ShipToOrganizationCode: string
Title:
Ship-to Organization Code
Maximum Length:18
Name of the inventory organization that receives the item. -
ShipToOrganizationId: integer
(int64)
Value that uniquely identifies the ship-to organization.
-
StartDate: string
(date)
Date on which the agreement becomes effective.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create price breaks for an agreement line. This step populates the interface tables with the agreement line's price breaks data.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/InterfaceHeaderId/child/lines/InterfaceLineId/child/priceBreaks"
Example 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.
{ "PriceBreakNumber": 1, "ShipToLocation": "V1- New York City", "ShipToOrganizationCode": "V1", "Price": 10, "StartDate": "2024-01-01", "EndDate": "2024-01-15" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "InterfaceLineLocationId" : 300100590200176, "InterfaceLineKey" : null, "InterfaceLineLocationKey" : null, "PriceBreakNumber" : 1, "ShipToLocation" : "V1- New York City", "ShipToLocationId" : null, "ShipToOrganizationCode" : "V1", "ShipToOrganizationId" : null, "Quantity" : null, "Price" : 10, "DiscountPercent" : null, "StartDate" : "2024-01-01", "EndDate" : "2024-01-15", "Attribute1" : null, "Attribute10" : null, "Attribute11" : null, "Attribute12" : null, "Attribute13" : null, "Attribute14" : null, "Attribute15" : null, "Attribute16" : null, "Attribute17" : null, "Attribute18" : null, "Attribute19" : null, "Attribute2" : null, "Attribute20" : null, "Attribute3" : null, "Attribute4" : null, "Attribute5" : null, "Attribute6" : null, "Attribute7" : null, "Attribute8" : null, "Attribute9" : null, "AttributeCategory" : null, "AttributeDate1" : null, "AttributeDate10" : null, "AttributeDate2" : null, "AttributeDate3" : null, "AttributeDate4" : null, "AttributeDate5" : null, "AttributeDate6" : null, "AttributeDate7" : null, "AttributeDate8" : null, "AttributeDate9" : null, "AttributeNumber1" : null, "AttributeNumber10" : null, "AttributeNumber2" : null, "AttributeNumber3" : null, "AttributeNumber4" : null, "AttributeNumber5" : null, "AttributeNumber6" : null, "AttributeNumber7" : null, "AttributeNumber8" : null, "AttributeNumber9" : null, "AttributeTimestamp1" : null, "AttributeTimestamp10" : null, "AttributeTimestamp2" : null, "AttributeTimestamp3" : null, "AttributeTimestamp4" : null, "AttributeTimestamp5" : null, "AttributeTimestamp6" : null, "AttributeTimestamp7" : null, "AttributeTimestamp8" : null, "AttributeTimestamp9" : null, "CreatedBy" : "PRC_INTEGRATION_USER", "CreationDate" : "2024-01-17T06:38:06.002+00:00", "LastUpdatedBy" : "PRC_INTEGRATION_USER", "LastUpdateDate" : "2024-01-17T06:38:06.002+00:00", "ProcessCode" : null, "RequestId" : null, "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348/child/lines/300100590200170/child/priceBreaks/300100590200176", "name" : "priceBreaks", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348/child/lines/300100590200170/child/priceBreaks/300100590200176", "name" : "priceBreaks", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590192348/child/lines/300100590200170", "name" : "lines", "kind" : "item" } ] }