Update one purchase agreement
/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}
Request
-
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.
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
- application/json
object-
AcknowledgmentWithinDays: number
Number of days that the supplier can decide to accept or reject the document.
-
AgingOnsetPoint: string
Title:
Aging Onset PointMaximum Length:80Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment. -
AgingOnsetPointCode: string
Maximum Length:
30Code that identifies the aging onset point. -
AgingPeriodDays: integer
(int32)
Value that identifies the maximum number of days the material may be on consignment.
-
AgreementAmount: number
Value that identifies the amount agreed upon for an agreement.
-
AgreementNumber: string
Maximum Length:
30Number that uniquely identifies the purchase agreement in the procurement business unit. -
AllowUnassignedSitesFlag: boolean
Maximum Length:
1Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments. -
AmountLimit: number
Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutomaticallyGenerateOrdersFlag: boolean
Maximum Length:
1Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not. -
AutomaticallySubmitForApprovalFlag: boolean
Maximum Length:
1Value that identifies whether the document can be automatically submitted for approval. -
AutoSourcingFlag: boolean
Maximum Length:
1Enable automatic sourcing -
BillingCycleClosingDate: string
(date)
Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.
-
businessUnitAccess: array
Business Unit Accesses
Title:
Business Unit AccessesAgreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services. -
Buyer: string
Title:
BuyerMaximum Length:240Person who's responsible for managing the purchase agreement. -
BuyerEmail: string
Title:
Buyer EmailMaximum Length:240Email address of the buyer. -
BuyerId: integer
(int64)
Value that uniquely identifies the buyer.
-
BuyerManagedTransportFlag: boolean
Title:
Buyer managed transportationMaximum Length:1Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order. -
Carrier: string
Title:
CarrierMaximum Length:360Company that transports the item. -
CarrierId: integer
(int64)
Value that uniquely identifies the company that transports the item.
-
ChangeOrderDescription: string
Maximum Length:
255Text that describes the reason or purpose of the change order. -
ChangeOrderInitiatingParty: string
Maximum Length:
255Party where the purchase document change request originated. Valid values are requester, buyer, supplier, and catalog administrator. -
Checklist: string
Maximum Length:
80Title of the compliance checklist. -
ChecklistId: integer
(int64)
Value that uniquely identifies the checklist associated with the purchasing document.
-
ChecklistNumber: string
Maximum Length:
30Number that uniquely identifies the compliance checklist. -
CommunicateRepricedOrdersFlag: boolean
Maximum Length:
1Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier. -
ConfirmingOrderFlag: boolean
Title:
Confirming orderMaximum Length:1Value that identifies whether the document is a confirmation of an order the supplier may already be aware of. -
ConsumptionAdviceFrequency: string
Title:
Consumption Advice FrequencyMaximum Length:80Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceFrequencyCode: string
Maximum Length:
30Code that indicates the consumption advice frequency. -
ConsumptionAdviceSummary: string
Title:
Consumption Advice SummaryMaximum Length:80Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceSummaryCode: string
Maximum Length:
30Code that indicates the consumption advice summary. -
contractDocuments: array
Contract Documents for Contract Terms
Title:
Contract Documents for Contract TermsDetails of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. -
ContractTermsExists: string
Maximum Length:
1Contains one of the following values: true or false. If true, contract clauses were added from the terms library to the purchase agreement. If false, the purchase agreement doesn't contain any contract clauses from the terms library. This attribute has no default value. -
Currency: string
Title:
Currency NameMaximum Length:80Currency of the purchase agreement. -
CurrencyCode: string
Maximum Length:
15Code that identifies the purchase agreement currency. -
DefaultConsignmentLineFlag: boolean
Maximum Length:
1Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default. -
Description: string
Maximum Length:
240Description of the purchase agreement. -
DFF: array
DFF
-
DocumentCreationMethod: string
Maximum Length:
30Method by which the document was created. -
DocumentStyle: string
Title:
StyleMaximum Length:240Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document. -
DocumentStyleId: integer
(int64)
Value that uniquely identifies the purchasing document style.
-
DocumentType: string
Title:
Document TypeMaximum Length:80Value that identifies the document type associated with a change order template. -
DocumentTypeCode: string
Maximum Length:
25Code that identifies the document type. -
EnableRetroactivePricingFlag: boolean
Maximum Length:
1Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement. -
EndDate: string
(date)
Date after which the purchase agreement is no longer valid.
-
FOB: string
Title:
FOBMaximum Length:80Freight on board. Location where ownership of the item transfers from the supplier to the buyer. -
FOBCode: string
Maximum Length:
30Code that identifies the type of free-on-board terms for the document. -
FreightTerms: string
Title:
Freight TermsMaximum Length:80Terms that describe who pays charges to transport the item. -
FreightTermsCode: string
Maximum Length:
30Code that identifies the type of freight terms for the document -
GroupRequisitionLinesFlag: boolean
Maximum Length:
1Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order. -
GroupRequisitionsFlag: boolean
Maximum Length:
1Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order. -
InitiateRetroactivePricingUponApprovalFlag: boolean
Maximum Length:
1Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval. -
lines: array
Purchase Agreement Lines
Title:
Purchase Agreement LinesDetails of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops. -
MasterContractId: integer
(int64)
Value that uniquely identifies the associated contract.
-
MasterContractNumber: string
Title:
Master ContractMaximum Length:120Number that identifies the contract from enterprise contracts. -
MasterContractType: string
Title:
Master Contract TypeAdministrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms. -
MasterContractTypeId: integer
Value that uniquely identifies the master contract type.
-
MinimumReleaseAmount: number
Value that identifies the minimum amount that can be released against a purchase agreement.
-
ModeOfTransport: string
Title:
Mode of TransportMaximum Length:80Mode of transport to ship the item, such as truck, air, or boat. -
ModeOfTransportCode: string
Maximum Length:
30Mode of transport that the shipper uses to transport the item such as land, sea, and air. -
NoteToAuthorizer: string
Maximum Length:
1000Text comments to the approver, included as needed when submitting a document for approval. -
NoteToReceiver: string
Maximum Length:
1000Special text instructions to the receiver in the docking area to be reviewed while performing the receipt. -
NoteToSupplier: string
Maximum Length:
1000Note to the supplier for the purchase agreement. -
notificationControls: array
Notification Controls
Title:
Notification ControlsAgreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released. -
PaymentTerms: string
Title:
Payment TermsMaximum Length:50Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase agreement. -
PaymentTermsId: integer
(int64)
Value that uniquely identifies the payment terms.
-
PayOnReceiptFlag: boolean
Title:
Pay on ReceiptMaximum Length:25Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization. -
PayOnUseFlag: boolean
Maximum Length:
1Indicates whether invoices are automatically created when consigned material is consumed for document styles that allow consignment lines. -
PriceUpdateTolerance: number
Value that identifies the tolerance in percent above which if the price changes on an agreement line, the line should be highlighted to the user making the change.
-
Priority: number
Priority that determines how quickly to transport the item.
-
ProcurementBU: string
Title:
Procurement BUMaximum Length:240Business unit that manages and owns the purchase agreement. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the purchasing document.
-
PunchoutRequestsOnlyFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value. -
ReferenceNumber: string
Maximum Length:
120Number used for EDI transaction audit trail reference. -
RepriceOpenOrdersFlag: boolean
Maximum Length:
1Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement. -
RequiredAcknowledgment: string
Title:
Required AcknowledgmentMaximum Length:80Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment. -
RequiredAcknowledgmentCode: string
Maximum Length:
1Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required. -
RequiresSignatureFlag: boolean
Title:
Requires signatureMaximum Length:1Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No. -
ScheduleGroup: string
Maximum Length:
30Code that identifies the schedule group used to consolidate requisition demand into fewer purchase orders by applying order-generation schedules to agreements with the same ordering cadence. The Generate Orders process uses this value to process only requisitions sourced to agreements in the specified group. -
ScheduleGroupMeaning: string
Title:
Schedule GroupMaximum Length:80Display name or meaning of the schedule group. -
ServiceLevel: string
Title:
Service LevelMaximum Length:80Priority that determines how quickly to transport the item. -
ServiceLevelCode: string
Maximum Length:
30Value that identifies the priority of transportation that affects how quickly goods are transported. -
ShippingMethod: string
Title:
Shipping MethodShipping method on the purchasing document. -
StartDate: string
(date)
Date on which the agreement becomes effective.
-
Supplier: string
Maximum Length:
360Name of the supplier who fulfills the item. -
SupplierAgreement: string
Maximum Length:
25Number that indicates the supplier document number. -
SupplierCommunicationMethodCode: string
Maximum Length:
25Code that identifies the supplier communication method. -
SupplierContact: string
Maximum Length:
4000Person who represents the supplier when communicating with the buyer. -
SupplierContactId: integer
(int64)
Value that uniquely identifies the supplier contact.
-
SupplierEmailAddress: string
Maximum Length:
2000Value that identifies the email address specified on the document to which the document after approval will be communicated. -
SupplierFax: string
Maximum Length:
60Value that identifies the fax number specified on the document to which the document after approval will be communicated. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierPartyId: integer
Value that uniquely identifies the party for the supplier.
-
SupplierSite: string
Title:
SiteMaximum Length:240Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
supportingDocuments: array
Supporting Documents for Contract Terms
Title:
Supporting Documents for Contract TermsDetails of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. -
templateUsages: array
Template Usages
Title:
Template UsagesThe relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001. -
UseCustomerSalesOrderFlag: boolean
Maximum Length:
1Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order. -
UseOrderDateForOrderPricingFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value. -
UseRequestedDateFlag: boolean
Maximum Length:
1Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order. -
UseShipToLocationFlag: boolean
Maximum Length:
1Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders. -
UseShipToOrganizationAndLocationFlag: boolean
Maximum Length:
1Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders.
arrayAttachmentsarrayBusiness Unit AccessesarrayContract Documents for Contract TermsarrayPurchase Agreement LinesarrayNotification ControlsarraySupporting Documents for Contract TermsarrayTemplate Usagesobject-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
BillToBU: string
Title:
Bill-to BUMaximum Length:240Business unit that processes supplier invoices for the purchase document. -
BilltoBUId: integer
(int64)
Title:
Bill to BU IDValue that uniquely identifies the business unit that processes supplier invoices for the purchase order. -
BillToLocation: string
Title:
Bill-to LocationMaximum Length:240Value that identifies the bill-to location where the supplier sends the invoice. -
BillToLocationId: integer
(int64)
Value that uniquely identifies the bill-to location.
-
EnabledFlag: boolean
Maximum Length:
1Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default. -
EntityChangeTypeCode: string
Maximum Length:
1Value that identifies if the row is new or changed. -
OrderLocallyFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value. -
OrganizationAssignmentId: integer
(int64)
Value that uniquely identifies the business unit's access to a purchase agreement.
-
PurchasingSite: string
Title:
Purchasing SiteMaximum Length:240Name of the supplier site for the purchasing business unit. -
PurchasingSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the purchasing operating unit.
-
RequisitioningBU: string
Title:
Requisitioning BUMaximum Length:240Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that requested the goods or services being purchased.
-
ShipToLocation: string
Title:
Ship-to LocationMaximum Length:240Name of the location where the supplier ships the item. -
ShipToLocationCode: string
Title:
Ship-to Location CodeMaximum Length:60Abbreviation that identifies the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
object-
CategoryName: string
Title:
CategoryMaximum Length:30Name of the category to which the supporting document is assigned. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies if the contract document is a file or a URL. -
Description: string
Title:
DescriptionMaximum Length:255Description of the contract document. -
DmDocumentId: string
Maximum Length:
255Document identifier of the contract document in the content server. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder for the contract document in the content server. -
DmVersionNumber: string
Maximum Length:
255Version number of the contract document in the content server. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the contract document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the contract document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contract document. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the contract document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the contract document. -
FileUrl: string
Title:
File UrlURL of the contract document. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the contract document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type of the contract document. -
UploadedFileLength: integer
Title:
File SizeUploaded file length of the contract document. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name of the contract document. -
UploadedText: string
Title:
Uploaded TextUploaded text of the contract document. -
Uri: string
Title:
UriMaximum Length:4000URI of the contract document. -
Url: string
Title:
UrlMaximum Length:4000URL of the contract document.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
PoHeaderId: integer
(int64)
object-
AgingPeriodDays: integer
(int32)
Value that identifies the maximum number of days the material may be on consignment.
-
AgreementAmount: number
Value that identifies the amount agreed for an agreement line.
-
AgreementQuantity: number
Quantity agreed for an agreement line.
-
AllowItemDescriptionUpdateFlag: boolean
Maximum Length:
1Value that identifies whether item descriptions can be updated on document lines. -
AllowPriceOverrideFlag: boolean
Maximum Length:
1Value that indicates whether a price limit can be provided for an agreement line. Possible values: Y and N. -
Amount: number
Value that identifies the amount agreed on an agreement line between the buying and selling organization.
-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CancelFlag: boolean
Maximum Length:
1Indicates whether the agreement line is canceled. Possible values: Y and N. -
CancelledBy: integer
(int64)
User who canceled the purchase agreement line.
-
CancelReason: string
Maximum Length:
240Reason provided for canceling the agreement line. -
Category: string
Maximum Length:
2400Value that uniquely identifies the purchasing category. -
CategoryCode: string
Maximum Length:
820Abbreviation that identifies the purchasing category. -
CategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
ConsignmentLineFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the blanket purchase agreement and the purchase order include consignment lines. If false, then the blanket purchase agreement and the purchase order don't include consignment lines. The default value is false. -
Description: string
Maximum Length:
240Description for the line item. -
DFF: array
DFF
-
ExpirationDate: string
(date)
Value that identifies the expiration date of the agreement line.
-
HazardClass: string
Title:
Hazard ClassMaximum Length:40Name of the hazard class. -
HazardClassCode: string
Title:
Hazard Class CodeMaximum Length:30Code that identifies the hazard class. -
HazardClassId: integer
(int64)
Value that uniquely identifies the hazard class.
-
Item: string
Title:
ItemAbbreviation that uniquely identifies the item on the purchase agreement line. -
itemAttributes: array
Item Attributes
Title:
Item AttributesAgreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the purchase agreement.
-
ItemRevision: string
Maximum Length:
18Value that identifies the revision number of the item. -
LineNumber(required): number
Value that uniquely identifies the purchase order or agreement line.
-
LineStartDate: string
(date)
Date after which the agreement line becomes effective.
-
LineType: string
Title:
Line TypeMaximum Length:30Line type on purchasing documents. -
LineTypeId(required): integer
(int64)
Value that uniquely identifies the line type on your documents.
-
MinimumReleaseAmount: number
Minimum amount that can be released against the blanket purchase agreement.
-
NegotiatedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the buyer and the supplier negotiated and agreed on the price before the purchase. If false, then the buyer and the supplier didn't negotiate the price before the purchase. This attribute doesn't have a default value. -
Negotiation: string
Maximum Length:
240Value that identifies the negotiation number. -
NoteToSupplier: string
Maximum Length:
1000Value that uniquely identifies a note to supplier. -
ParentItem: string
Maximum Length:
255Value that uniquely identifies the parent option class or model for the item. -
ParentItemId: integer
(int64)
Value that uniquely identifies the parent option class or model for the item.
-
Price: number
Unit price for the line.
-
priceBreaks: array
Price Breaks
Title:
Price BreaksAgreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location. -
PriceBreakType: string
Title:
Price Break TypeMaximum Length:80Value that identifies the pricing scheme for the price breaks of this line. -
PriceBreakTypeCode: string
Maximum Length:
25Code that identifies the pricing scheme for the price breaks of this line. -
PriceLimit: number
Value that identifies the price limit that can't be exceeded on a purchase order referencing the blanket agreement line.
-
ReasonForChange: string
Maximum Length:
240Value that identifies the reason for changing the line. -
SupplierItem: string
Maximum Length:
300Value that identifies the supplier item number. -
SupplierParentItem: string
Maximum Length:
300Value that identifies the supplier's identification number for the option class or model associated with item. -
SupplierPartAuxid: string
Maximum Length:
255Supplier item auxiliary identifier for the blanket agreement line. -
SupplierTopModel: string
Maximum Length:
300Value that identifies the supplier top model associated with the option, option class, or submodel. -
TopModel: string
Maximum Length:
255Value that identifies the top model associated with the option or option class or submodel. -
TopModelId: integer
(int64)
Value that uniquely identifies the top model associated with the option, option class, or submodel.
-
UNNumber: string
Title:
UN NumberMaximum Length:20Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UNNumberDescription: string
Title:
UN Number DescriptionMaximum Length:240Description of the hazardous material referenced by the UN number. -
UNNumberId: integer
(int64)
Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
-
UOM: string
Title:
UOMMaximum Length:25Abbreviation that identifies the unit of measure on the agreement line -
UOMCode: string
Maximum Length:
3Code that identifies the unit of measure.
arrayAttachmentsarrayItem AttributesarrayPrice Breaksobject-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
PoLineId: integer
(int64)
object-
Alias: string
Maximum Length:
700Alternate identifier for an item specified on a blanket purchase agreement line. -
AttachmentURL: string
Maximum Length:
700URL of the attachment associated with the item. -
Availability: string
Maximum Length:
700Status of the item availability from supplier. -
Comments: string
Maximum Length:
700Additional comments for the item specified on the blanket purchase agreement line. -
DFF: array
DFF
-
ImageURL: string
Maximum Length:
700URL of the image file associated with the item specified on a blanket purchase agreement line. -
LeadTimeDays: number
Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.
-
LongDescription: string
Maximum Length:
4000Text describing the long description of the item specified on a blanket purchase agreement line. -
Manufacturer: string
Maximum Length:
700Name of the manufacturer of the item specified on a blanket purchase agreement line. -
ManufacturerPartNumber: string
Maximum Length:
700Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line. -
ManufacturerURL: string
Maximum Length:
700URL of the manufacturer of the item specified on a blanket purchase agreement line. -
PackagingString: string
Maximum Length:
240String that describes how the item is packed by the supplier. -
RoundingFactor: number
Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
-
SupplierURL: string
Maximum Length:
700URL of the supplier's organization. -
ThumbnailImageURL: string
Maximum Length:
700Location of the small version of a larger image file for the item specified on the blanket purchase agreement. -
UNSPSC: string
Maximum Length:
700The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:240Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt
object-
attachments: array
Attachments
Title:
AttachmentsThe 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:
LocationMaximum Length:240Name of the location where the supplier ships the item. -
LocationCode: string
Title:
NameMaximum Length:60Abbreviation 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:
240Value that identifies the reason for changing the agreement price break. -
ShipToOrganization: string
Title:
Ship-to OrganizationMaximum Length:240Name of the inventory organization that receives the item. -
ShipToOrganizationCode: string
Maximum Length:
18Abbreviation 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:
3Code that identifies the unit of measure.
arrayAttachmentsobject-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt
object-
Amount: number
Notification amount of purchase agreement document total.
-
Condition: string
Title:
ConditionMaximum Length:80Notification type of the purchase agreement. -
ConditionCode: string
Maximum Length:
25Notification type of the purchase agreement. -
DFF: array
DFF
-
EndDate: string
(date)
Expiration date of the notification.
-
Percentage: number
Notification percentage of purchase agreement document total.
-
ReminderDays: number
Title:
Reminder DaysValue that identifies the number of days before the expiration event that the reminder notification needs to be sent. -
StartDate: string
(date)
Effective date of the notification.
object-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
NotificationId: integer
(int64)
object-
CategoryName: string
Title:
CategoryMaximum Length:30Code for the category to which the supporting document is assigned. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies if the supporting document is a file or a URL. -
Description: string
Title:
DescriptionMaximum Length:255Description of the supporting document. -
DmDocumentId: string
Maximum Length:
255Document identifier of the supporting document in the content server. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder for the supporting document in the content server. -
DmVersionNumber: string
Maximum Length:
255Version number of the supporting document in the content server. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the supporting document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the supporting document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the supporting document. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the supporting document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the supporting document. A file name or URL is required. -
FileUrl: string
Title:
File UrlURL location of the supporting document. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the supporting document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type of the supporting document. -
UploadedFileLength: integer
Title:
File SizeUploaded file length of the supporting document. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name of the supporting document. -
UploadedText: string
Title:
Uploaded TextUploaded text of the supporting document. -
Uri: string
Title:
UriMaximum Length:4000URI of the supporting document. -
Url: string
Title:
UrlMaximum Length:4000URL of the supporting document.
object-
AuthoringParty: string
Maximum Length:
255Indicates which party was the author of the contract terms for the document. -
AuthoringPartyCode(required): string
Title:
Authoring PartyMaximum Length:30Code that indicates which party was the author of the contract terms for the document. -
ContractFormAttachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ContractSourceCode: string
Title:
Contract SourceMaximum Length:30Indicates the current source of the contract terms for the business document. Valid values are STRUCTURED and ATTACHED. -
DocumentNumber: string
Title:
Document NumberMaximum Length:150Number of the business document that's associated with a contract template. -
SimpleContractText: string
(byte)
HTML content of the simple contract terms.
-
SimpleContractYn: string
Maximum Length:
1Indicates whether the contract is simple. -
TemplateId: number
Title:
Contract Terms TemplateUnique identifier for the contract template used in the business document.
arrayAttachmentsobject-
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
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-
AcknowledgmentDueDate: string
(date)
Read Only:
trueDate that the application requests the supplier to acknowledge the document. -
AcknowledgmentWithinDays: number
Number of days that the supplier can decide to accept or reject the document.
-
AgingOnsetPoint: string
Title:
Aging Onset PointMaximum Length:80Value that identifies the mutually agreed event point at which consigned material begins to age. The possible values for aging onset point are None, Receipt, and Shipment. -
AgingOnsetPointCode: string
Maximum Length:
30Code that identifies the aging onset point. -
AgingPeriodDays: integer
(int32)
Value that identifies the maximum number of days the material may be on consignment.
-
AgreementAmount: number
Value that identifies the amount agreed upon for an agreement.
-
AgreementHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase agreement. -
AgreementNumber: string
Maximum Length:
30Number that uniquely identifies the purchase agreement in the procurement business unit. -
AllowUnassignedSitesFlag: boolean
Maximum Length:
1Value that identifies whether the agreement can be used to order from supplier sites not listed as a purchasing site in the agreement's business unit assignments. -
AmountLimit: number
Value that identifies the amount limit on an agreement beyond which releases can't be created against the agreement.
-
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
AutomaticallyGenerateOrdersFlag: boolean
Maximum Length:
1Value that identifies whether an order should be automatically created for a requisition line referencing the agreement or not. -
AutomaticallySubmitForApprovalFlag: boolean
Maximum Length:
1Value that identifies whether the document can be automatically submitted for approval. -
AutoSourcingFlag: boolean
Maximum Length:
1Enable automatic sourcing -
BillingCycleClosingDate: string
(date)
Date when the current billing period for an agreement ends. This is applicable only for a BPA with consignment terms enabled.
-
businessUnitAccess: array
Business Unit Accesses
Title:
Business Unit AccessesAgreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services. -
Buyer: string
Title:
BuyerMaximum Length:240Person who's responsible for managing the purchase agreement. -
BuyerEmail: string
Title:
Buyer EmailMaximum Length:240Email address of the buyer. -
BuyerFullName: string
Title:
Buyer Full NameRead Only:trueMaximum Length:240Display name of the buyer on the purchasing document. -
BuyerId: integer
(int64)
Value that uniquely identifies the buyer.
-
BuyerManagedTransportFlag: boolean
Title:
Buyer managed transportationMaximum Length:1Value that identifies that the buying company is responsible for arranging the transportation, from picking up the requested goods to delivering to ship-to locations specified on the order. -
CancelDocumentFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the purchase agreement is canceled. Valid values: True or False. -
Carrier: string
Title:
CarrierMaximum Length:360Company that transports the item. -
CarrierId: integer
(int64)
Value that uniquely identifies the company that transports the item.
-
ChangeOrderCreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the change order. -
ChangeOrderDescription: string
Maximum Length:
255Text that describes the reason or purpose of the change order. -
ChangeOrderInitiatingParty: string
Maximum Length:
255Party where the purchase document change request originated. Valid values are requester, buyer, supplier, and catalog administrator. -
ChangeOrderInitiatorId: integer
(int64)
Read Only:
trueValue that uniquely identifies the user who initiated the change order. -
ChangeOrderInitiatorRole: string
Read Only:
trueMaximum Length:255Role of the user who created the change order. -
ChangeOrderNumber: string
Title:
Change Order NumberRead Only:trueMaximum Length:80Number that uniquely identifies the change order for a purchasing document. -
ChangeOrderSequence: integer
Title:
Change Order SequenceRead Only:trueThe sequence number for each change order. This is internally generated (start with 0) and increment by 1 for each new change order created for the document. -
ChangeOrderStatus: string
Read Only:
trueMaximum Length:255Status of the change order relative to the change order life cycle. -
ChangeOrderStatusCode: string
Read Only:
trueMaximum Length:25Abbreviation that identifies the change order status. -
ChangeOrderType: string
Read Only:
trueMaximum Length:255Value that indicates whether change order is an internal change order or an external change order. Suppliers can view the external changes. -
ChangeOrderTypeCode: string
Read Only:
trueMaximum Length:1Abbreviation that defines the change order type. -
ChangeRequestedBy: string
Read Only:
trueMaximum Length:360User who requested changes to the purchase agreement. -
Checklist: string
Maximum Length:
80Title of the compliance checklist. -
ChecklistId: integer
(int64)
Value that uniquely identifies the checklist associated with the purchasing document.
-
ChecklistNumber: string
Maximum Length:
30Number that uniquely identifies the compliance checklist. -
CommunicateRepricedOrdersFlag: boolean
Maximum Length:
1Value that identifies whether or not orders that were repriced because of a price change on the referenced agreement should be communicated to the supplier. -
ConfiguredItemFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the document style allows configuration items on agreements and purchase orders. -
ConfirmingOrderFlag: boolean
Title:
Confirming orderMaximum Length:1Value that identifies whether the document is a confirmation of an order the supplier may already be aware of. -
ConsignedItemsFlag: boolean
Title:
Consignment Terms EnabledRead Only:trueMaximum Length:1Indicates whether the document style allows consignment lines on agreements and purchase orders. -
ConsumptionAdviceFrequency: string
Title:
Consumption Advice FrequencyMaximum Length:80Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceFrequencyCode: string
Maximum Length:
30Code that indicates the consumption advice frequency. -
ConsumptionAdviceSummary: string
Title:
Consumption Advice SummaryMaximum Length:80Value that identifies the default value of the frequency at which the consumption advice will be generated for all consumption transactions for consigned inventory purchased under this agreement. The possible values for consumption advice frequency are Daily, Weekly, and Monthly. -
ConsumptionAdviceSummaryCode: string
Maximum Length:
30Code that indicates the consumption advice summary. -
contractDocuments: array
Contract Documents for Contract Terms
Title:
Contract Documents for Contract TermsDetails of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. -
ContractTermsExists: string
Maximum Length:
1Contains one of the following values: true or false. If true, contract clauses were added from the terms library to the purchase agreement. If false, the purchase agreement doesn't contain any contract clauses from the terms library. This attribute has no default value. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the purchase agreement. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the purchase agreement. -
Currency: string
Title:
Currency NameMaximum Length:80Currency of the purchase agreement. -
CurrencyCode: string
Maximum Length:
15Code that identifies the purchase agreement currency. -
DefaultConsignmentLineFlag: boolean
Maximum Length:
1Value that identifies whether the lines added on this blanket agreement should be marked as consigned lines by default. -
Description: string
Maximum Length:
240Description of the purchase agreement. -
DFF: array
DFF
-
DocumentCreationMethod: string
Maximum Length:
30Method by which the document was created. -
DocumentStyle: string
Title:
StyleMaximum Length:240Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document. -
DocumentStyleId: integer
(int64)
Value that uniquely identifies the purchasing document style.
-
DocumentType: string
Title:
Document TypeMaximum Length:80Value that identifies the document type associated with a change order template. -
DocumentTypeCode: string
Maximum Length:
25Code that identifies the document type. -
EnableRetroactivePricingFlag: boolean
Maximum Length:
1Value that identifies whether all orders or only open orders should be automatically updated with retroactive price changes entered on their corresponding blanket agreement. -
EndDate: string
(date)
Date after which the purchase agreement is no longer valid.
-
EntityChangeTypeCode: string
Read Only:
trueMaximum Length:1Value that indicates if the header is changed. -
FOB: string
Title:
FOBMaximum Length:80Freight on board. Location where ownership of the item transfers from the supplier to the buyer. -
FOBCode: string
Maximum Length:
30Code that identifies the type of free-on-board terms for the document. -
FreightTerms: string
Title:
Freight TermsMaximum Length:80Terms that describe who pays charges to transport the item. -
FreightTermsCode: string
Maximum Length:
30Code that identifies the type of freight terms for the document -
GroupRequisitionLinesFlag: boolean
Maximum Length:
1Value that identifies whether or not requisition lines referencing the same agreement line should be grouped when creating an order. -
GroupRequisitionsFlag: boolean
Maximum Length:
1Value that identifies whether or not requisition lines of different requisitions referencing the same agreement line should be grouped when creating an order. -
IdentificationKey: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the approval actions of a purchase agreement. -
InitiateRetroactivePricingUponApprovalFlag: boolean
Maximum Length:
1Value that identifies whether or not the retroactive price update background process should be initiated upon agreement approval. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application last updated the purchase agreement. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the purchase agreement. -
LatestIdentificationKey: string
Read Only:
trueMaximum Length:255Value that uniquely identifies the header of the purchase agreement. -
lines: array
Purchase Agreement Lines
Title:
Purchase Agreement LinesDetails of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MasterContractId: integer
(int64)
Value that uniquely identifies the associated contract.
-
MasterContractNumber: string
Title:
Master ContractMaximum Length:120Number that identifies the contract from enterprise contracts. -
MasterContractType: string
Title:
Master Contract TypeAdministrator-created classification for enterprise contracts that determines contract functionality, including the presence of lines and contract terms. -
MasterContractTypeId: integer
Value that uniquely identifies the master contract type.
-
MinimumReleaseAmount: number
Value that identifies the minimum amount that can be released against a purchase agreement.
-
ModeOfTransport: string
Title:
Mode of TransportMaximum Length:80Mode of transport to ship the item, such as truck, air, or boat. -
ModeOfTransportCode: string
Maximum Length:
30Mode of transport that the shipper uses to transport the item such as land, sea, and air. -
Negotiation: string
Title:
NegotiationRead Only:trueMaximum Length:255Number that uniquely identifies the negotiation referenced by the purchase agreement. -
NegotiationId: integer
Read Only:
trueUnique identifier for the negotiation referenced by the purchase agreement. -
NoteToAuthorizer: string
Maximum Length:
1000Text comments to the approver, included as needed when submitting a document for approval. -
NoteToReceiver: string
Maximum Length:
1000Special text instructions to the receiver in the docking area to be reviewed while performing the receipt. -
NoteToSupplier: string
Maximum Length:
1000Note to the supplier for the purchase agreement. -
notificationControls: array
Notification Controls
Title:
Notification ControlsAgreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released. -
OkcContractId: integer
Title:
Contract IDRead Only:trueUnique identifier for the contract in Oracle Enterprise Contracts. -
OkcContractNumber: string
Title:
Contract NumberRead Only:trueMaximum Length:255Unique number for the contract in Oracle Enterprise Contracts. -
OutsideProcessingFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the document style allows outside processing lines on agreements. -
PaymentTerms: string
Title:
Payment TermsMaximum Length:50Terms used by the application to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase agreement. -
PaymentTermsId: integer
(int64)
Value that uniquely identifies the payment terms.
-
PayOnReceiptFlag: boolean
Title:
Pay on ReceiptMaximum Length:25Value that identifies whether to generate invoices automatically on behalf of the supplier when supplier owned material stocked in buying organization's premise is consumed by the buying organization. -
PayOnUseFlag: boolean
Maximum Length:
1Indicates whether invoices are automatically created when consigned material is consumed for document styles that allow consignment lines. -
PriceBreaksFlag: boolean
Title:
Price Breaks AllowedRead Only:trueMaximum Length:1Contains one of the following values: true or false. If true, then the price breaks are enabled for this document style. If false, then the price breaks aren't enabled for this document style. The default value is false. -
PriceUpdateTolerance: number
Value that identifies the tolerance in percent above which if the price changes on an agreement line, the line should be highlighted to the user making the change.
-
Priority: number
Priority that determines how quickly to transport the item.
-
ProcurementBU: string
Title:
Procurement BUMaximum Length:240Business unit that manages and owns the purchase agreement. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the purchasing document.
-
PunchoutRequestsOnlyFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then automatic document sourcing will only restrict the contract agreement to be the source document for punchout requisition lines. If false, then automatic document sourcing will use the contract agreement as a source document for all requisition lines. This attribute doesn't have a default value. -
ReferenceNumber: string
Maximum Length:
120Number used for EDI transaction audit trail reference. -
ReleasedAmount: number
Title:
Released AmountRead Only:trueValue that identifies the amount released against this agreement. It's the sum of all approved purchase order amounts. -
RepriceOpenOrdersFlag: boolean
Maximum Length:
1Value that identifies whether or not the retroactive price update background process should only reprice open unfulfilled orders referencing the agreement. -
RequiredAcknowledgment: string
Title:
Required AcknowledgmentMaximum Length:80Acknowledgment that the application requires from the supplier. Values include document and schedule when supplier must acknowledge the header and schedule of the purchase agreement, document when supplier must acknowledge the header of the purchase agreement, or none when the purchase agreement doesn't require an acknowledgment. -
RequiredAcknowledgmentCode: string
Maximum Length:
1Indicates whether a supplier acknowledgment is required on the document and if required, what level it's required. -
RequiresSignatureFlag: boolean
Title:
Requires signatureMaximum Length:1Value that identifies if signatures are required on the purchasing document before it can be implemented. Possible values are Yes, or No. -
ScheduleGroup: string
Maximum Length:
30Code that identifies the schedule group used to consolidate requisition demand into fewer purchase orders by applying order-generation schedules to agreements with the same ordering cadence. The Generate Orders process uses this value to process only requisitions sourced to agreements in the specified group. -
ScheduleGroupMeaning: string
Title:
Schedule GroupMaximum Length:80Display name or meaning of the schedule group. -
ServiceLevel: string
Title:
Service LevelMaximum Length:80Priority that determines how quickly to transport the item. -
ServiceLevelCode: string
Maximum Length:
30Value that identifies the priority of transportation that affects how quickly goods are transported. -
ShippingMethod: string
Title:
Shipping MethodShipping method on the purchasing document. -
StartDate: string
(date)
Date on which the agreement becomes effective.
-
Status: string
Title:
StatusRead Only:trueMaximum Length:80Status of the purchase agreement relative to the purchase agreement life cycle. -
StatusCode: string
Read Only:
trueMaximum Length:40Value that identifies the header status. -
Supplier: string
Maximum Length:
360Name of the supplier who fulfills the item. -
SupplierAgreement: string
Maximum Length:
25Number that indicates the supplier document number. -
SupplierCommunicationMethodCode: string
Maximum Length:
25Code that identifies the supplier communication method. -
SupplierContact: string
Maximum Length:
4000Person who represents the supplier when communicating with the buyer. -
SupplierContactFullName: string
Read Only:
trueDisplay name of the supplier contact. -
SupplierContactId: integer
(int64)
Value that uniquely identifies the supplier contact.
-
SupplierEmailAddress: string
Maximum Length:
2000Value that identifies the email address specified on the document to which the document after approval will be communicated. -
SupplierFax: string
Maximum Length:
60Value that identifies the fax number specified on the document to which the document after approval will be communicated. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierPartyId: integer
Value that uniquely identifies the party for the supplier.
-
SupplierPayOnUseFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether pay-on-use is enabled for this agreement. -
SupplierSite: string
Title:
SiteMaximum Length:240Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
supportingDocuments: array
Supporting Documents for Contract Terms
Title:
Supporting Documents for Contract TermsDetails of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. -
templateUsages: array
Template Usages
Title:
Template UsagesThe relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001. -
UseCustomerSalesOrderFlag: boolean
Maximum Length:
1Value that identifies whether requisition lines should be grouped by sales order number to create distinct purchase order. -
UseOrderDateForOrderPricingFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the order date should be used to derive price on the orders referencing the agreement. If false, then the requested delivery date should be used to derive price on the orders referencing the agreement. This attribute doesn't have a default value. -
UseRequestedDateFlag: boolean
Maximum Length:
1Value that identifies whether to use the date on requisition lines that the buying company requests the supplier to deliver the goods when trying to group requisitions while creating an order. -
UseShipToLocationFlag: boolean
Maximum Length:
1Value that identifies whether to enable grouping requisitions by the requisition line ship-to location when creating orders. -
UseShipToOrganizationAndLocationFlag: boolean
Maximum Length:
1Indicates whether requisitions are grouped by both ship-to organization and ship-to location when creating orders. -
VersionId: integer
(int64)
Read Only:
trueValue that uniquely identifies the current version of the purchase agreement.
arrayAttachmentsarrayBusiness Unit AccessesarrayContract Documents for Contract TermsarrayPurchase Agreement LinesarrayLinksarrayNotification ControlsarraySupporting Documents for Contract TermsarrayTemplate Usagesobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
object-
BillToBU: string
Title:
Bill-to BUMaximum Length:240Business unit that processes supplier invoices for the purchase document. -
BilltoBUId: integer
(int64)
Title:
Bill to BU IDValue that uniquely identifies the business unit that processes supplier invoices for the purchase order. -
BillToLocation: string
Title:
Bill-to LocationMaximum Length:240Value that identifies the bill-to location where the supplier sends the invoice. -
BillToLocationId: integer
(int64)
Value that uniquely identifies the bill-to location.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the business unit access on the purchase agreement -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or the application created the business unit access for the purchase agreement. -
EnabledFlag: boolean
Maximum Length:
1Indicates whether the business unit assignment on the agreement is enabled. Values: true or false. No default. -
EntityChangeTypeCode: string
Maximum Length:
1Value that identifies if the row is new or changed. -
IsOrderLocallyReadOnlyFlag: boolean
Read Only:
trueMaximum Length:255Indicates whether the Order Locally setting for the client business unit is read-only. Values: true or false. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application last updated the business unit access of a purchase agreement. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the business unit access of a purchase agreement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrderLocallyFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the client's order for items on the agreement should be routed to local supplier sites maintained by the client. If false, then the client's order for items on the agreement won't route to local supplier sites maintained by the client. This attribute doesn't have a default value. -
OrganizationAssignmentId: integer
(int64)
Value that uniquely identifies the business unit's access to a purchase agreement.
-
PurchasingSite: string
Title:
Purchasing SiteMaximum Length:240Name of the supplier site for the purchasing business unit. -
PurchasingSiteId: integer
(int64)
Value that uniquely identifies the supplier site for the purchasing operating unit.
-
RequisitioningBU: string
Title:
Requisitioning BUMaximum Length:240Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that requested the goods or services being purchased.
-
ShipToLocation: string
Title:
Ship-to LocationMaximum Length:240Name of the location where the supplier ships the item. -
ShipToLocationCode: string
Title:
Ship-to Location CodeMaximum Length:60Abbreviation that identifies the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Value that uniquely identifies the location where the supplier ships the shipment item.
arrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAsynchronous tracker ID of the contract document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the contract document. -
CategoryName: string
Title:
CategoryMaximum Length:30Name of the category to which the supporting document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies if the contract document is a file or a URL. -
Description: string
Title:
DescriptionMaximum Length:255Description of the contract document. -
DmDocumentId: string
Maximum Length:
255Document identifier of the contract document in the content server. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder for the contract document in the content server. -
DmVersionNumber: string
Maximum Length:
255Version number of the contract document in the content server. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the contract document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the contract document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the contract document. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the contract document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the contract document. -
FileUrl: string
Title:
File UrlURL of the contract document. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the contract document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type of the contract document. -
UploadedFileLength: integer
Title:
File SizeUploaded file length of the contract document. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name of the contract document. -
UploadedText: string
Title:
Uploaded TextUploaded text of the contract document. -
Uri: string
Title:
UriMaximum Length:4000URI of the contract document. -
Url: string
Title:
UrlMaximum Length:4000URL of the contract document. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Name of the category to which the contract document is assigned.
arrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PoHeaderId: integer
(int64)
arrayLinksobject-
AcknowledgeResponseCode: string
Read Only:
trueMaximum Length:1Abbreviation that identifies the acknowledgment response for the agreement line. Values include Y when the agreement line is accepted and N when the line is rejected. -
AgingPeriodDays: integer
(int32)
Value that identifies the maximum number of days the material may be on consignment.
-
AgreementAmount: number
Value that identifies the amount agreed for an agreement line.
-
AgreementHeaderId: integer
(int64)
Read Only:
trueValue that uniquely identifies the purchase agreement. -
AgreementLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the agreement line. -
AgreementQuantity: number
Quantity agreed for an agreement line.
-
AllowItemDescriptionUpdateFlag: boolean
Maximum Length:
1Value that identifies whether item descriptions can be updated on document lines. -
AllowPriceOverrideFlag: boolean
Maximum Length:
1Value that indicates whether a price limit can be provided for an agreement line. Possible values: Y and N. -
Amount: number
Value that identifies the amount agreed on an agreement line between the buying and selling organization.
-
AmountReleased: number
Read Only:
trueValue that identifies the amount released for a purchase agreement line. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CancelFlag: boolean
Maximum Length:
1Indicates whether the agreement line is canceled. Possible values: Y and N. -
CancelledBy: integer
(int64)
User who canceled the purchase agreement line.
-
CancelReason: string
Maximum Length:
240Reason provided for canceling the agreement line. -
Category: string
Maximum Length:
2400Value that uniquely identifies the purchasing category. -
CategoryCode: string
Maximum Length:
820Abbreviation that identifies the purchasing category. -
CategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
ComponentAmountReleased: number
Read Only:
trueTotal value of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product. -
ComponentQuantityReleased: number
Read Only:
trueTotal quantity of orders released against a blanket line item as an optional component of a configuration. A configuration is a unique item created by a customer who selected desired options as part of the finished product. -
ConsignmentLineFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the blanket purchase agreement and the purchase order include consignment lines. If false, then the blanket purchase agreement and the purchase order don't include consignment lines. The default value is false. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the purchase agreement line. -
Currency: string
Title:
CurrencyRead Only:trueMaximum Length:80Currency on the purchase agreement line. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Code that identifies the purchase agreement currency. -
DeliveredAmount: number
Read Only:
trueValue that identifies the amount delivered for a purchase agreement line. -
DeliveredQuantity: number
Read Only:
trueQuantity delivered for an agreement line. -
Description: string
Maximum Length:
240Description for the line item. -
DFF: array
DFF
-
EntityChangeTypeCode: string
Read Only:
trueMaximum Length:1Indicates whether the record is new or changed. -
ExpirationDate: string
(date)
Value that identifies the expiration date of the agreement line.
-
HazardClass: string
Title:
Hazard ClassMaximum Length:40Name of the hazard class. -
HazardClassCode: string
Title:
Hazard Class CodeMaximum Length:30Code that identifies the hazard class. -
HazardClassId: integer
(int64)
Value that uniquely identifies the hazard class.
-
InvoicedAmount: number
Read Only:
trueValue that identifies the amount invoiced for a purchase agreement line. -
InvoicedQuantity: number
Read Only:
trueQuantity invoiced for an agreement line. -
IsLineApprovedOnceFlag: boolean
Read Only:
trueIndicates whether a line has been approved at least once. -
Item: string
Title:
ItemAbbreviation that uniquely identifies the item on the purchase agreement line. -
ItemAllowItemDescriptionUpdateFlag: boolean
Read Only:
trueMaximum Length:255Value that identifies whether item descriptions can be updated on document lines. -
itemAttributes: array
Item Attributes
Title:
Item AttributesAgreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television. -
ItemId: integer
(int64)
Value that uniquely identifies the item on the purchase agreement.
-
ItemRevision: string
Maximum Length:
18Value that identifies the revision number of the item. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application last updated the purchase agreement line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the purchase agreement line. -
LineNumber: number
Value that uniquely identifies the purchase order or agreement line.
-
LineStartDate: string
(date)
Date after which the agreement line becomes effective.
-
LineType: string
Title:
Line TypeMaximum Length:30Line type on purchasing documents. -
LineTypeId: integer
(int64)
Value that uniquely identifies the line type on your documents.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MinimumReleaseAmount: number
Minimum amount that can be released against the blanket purchase agreement.
-
NegotiatedFlag: boolean
Maximum Length:
1Contains one of the following values: true or false. If true, then the buyer and the supplier negotiated and agreed on the price before the purchase. If false, then the buyer and the supplier didn't negotiate the price before the purchase. This attribute doesn't have a default value. -
Negotiation: string
Maximum Length:
240Value that identifies the negotiation number. -
NoteToSupplier: string
Maximum Length:
1000Value that uniquely identifies a note to supplier. -
ParentItem: string
Maximum Length:
255Value that uniquely identifies the parent option class or model for the item. -
ParentItemId: integer
(int64)
Value that uniquely identifies the parent option class or model for the item.
-
PimItemCategory: string
Read Only:
trueMaximum Length:255Name of the purchasing category associated with the item. -
PimItemCategoryCode: string
Read Only:
trueMaximum Length:255Abbreviation that identifies the purchasing category associated with the item. -
PimItemCategoryId: integer
Read Only:
trueValue that uniquely identifies the purchasing category associated with the item. -
PimItemDescription: string
Read Only:
trueMaximum Length:255Description of the item that the purchase order line references. -
Price: number
Unit price for the line.
-
priceBreaks: array
Price Breaks
Title:
Price BreaksAgreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location. -
PriceBreakType: string
Title:
Price Break TypeMaximum Length:80Value that identifies the pricing scheme for the price breaks of this line. -
PriceBreakTypeCode: string
Maximum Length:
25Code that identifies the pricing scheme for the price breaks of this line. -
PriceLimit: number
Value that identifies the price limit that can't be exceeded on a purchase order referencing the blanket agreement line.
-
PurchaseBasis: string
Read Only:
trueMaximum Length:30Value that indicates whether the line is for goods or services. -
PurchaseOrdersCreated: number
Read Only:
trueNumber of purchase orders created by referencing the agreement line. -
ReasonForChange: string
Maximum Length:
240Value that identifies the reason for changing the line. -
ReceivedAmount: number
Read Only:
trueValue that identifies the amount received for a purchase agreement line. -
ReceivedQuantity: number
Read Only:
trueQuantity received for an agreement line. -
RejectedReason: string
Read Only:
trueMaximum Length:240Reason for rejecting the line. -
ReleasedQuantity: number
Read Only:
trueQuantity released for an agreement line. -
Status: string
Title:
StatusRead Only:trueMaximum Length:80Status of an agreement line. -
StatusCode: string
Title:
Status CodeRead Only:trueMaximum Length:25Code that identifies the agreement line status. -
SupplierItem: string
Maximum Length:
300Value that identifies the supplier item number. -
SupplierParentItem: string
Maximum Length:
300Value that identifies the supplier's identification number for the option class or model associated with item. -
SupplierPartAuxid: string
Maximum Length:
255Supplier item auxiliary identifier for the blanket agreement line. -
SupplierTopModel: string
Maximum Length:
300Value that identifies the supplier top model associated with the option, option class, or submodel. -
TopModel: string
Maximum Length:
255Value that identifies the top model associated with the option or option class or submodel. -
TopModelId: integer
(int64)
Value that uniquely identifies the top model associated with the option, option class, or submodel.
-
UNNumber: string
Title:
UN NumberMaximum Length:20Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UNNumberDescription: string
Title:
UN Number DescriptionMaximum Length:240Description of the hazardous material referenced by the UN number. -
UNNumberId: integer
(int64)
Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
-
UOM: string
Title:
UOMMaximum Length:25Abbreviation that identifies the unit of measure on the agreement line -
UOMCode: string
Maximum Length:
3Code that identifies the unit of measure.
arrayAttachmentsarrayItem AttributesarrayLinksarrayPrice Breaksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PoLineId: integer
(int64)
arrayLinksobject-
AgreementLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the agreement line. -
Alias: string
Maximum Length:
700Alternate identifier for an item specified on a blanket purchase agreement line. -
AttachmentURL: string
Maximum Length:
700URL of the attachment associated with the item. -
AttributeValuesId: integer
(int64)
Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
-
AttributeValuesTlpId: integer
(int64)
Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
-
Availability: string
Maximum Length:
700Status of the item availability from supplier. -
Comments: string
Maximum Length:
700Additional comments for the item specified on the blanket purchase agreement line. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the item attributes for a purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the item attributes for a purchase agreement line. -
DFF: array
DFF
-
EntityChangeTypeCode: string
Read Only:
trueMaximum Length:1Value that identifies if the row is new or changed. -
HazardClass: string
Title:
Hazard ClassRead Only:trueMaximum Length:40Name of the hazard class. -
HazardClassCode: string
Title:
CodeRead Only:trueMaximum Length:30Abbreviation that identifies the hazard class. -
HazardClassId: integer
(int64)
Read Only:
trueValue that uniquely identifies the hazard class. -
ImageURL: string
Maximum Length:
700URL of the image file associated with the item specified on a blanket purchase agreement line. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application last updated the item attributes on a purchase agreement line. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the item attributes on a purchase agreement line. -
LeadTimeDays: number
Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LongDescription: string
Maximum Length:
4000Text describing the long description of the item specified on a blanket purchase agreement line. -
Manufacturer: string
Maximum Length:
700Name of the manufacturer of the item specified on a blanket purchase agreement line. -
ManufacturerPartNumber: string
Maximum Length:
700Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line. -
ManufacturerURL: string
Maximum Length:
700URL of the manufacturer of the item specified on a blanket purchase agreement line. -
PackagingString: string
Maximum Length:
240String that describes how the item is packed by the supplier. -
RoundingFactor: number
Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
-
SupplierPartAuxid: string
Read Only:
trueMaximum Length:255Supplier item auxiliary identifier for the blanket agreement line. -
SupplierURL: string
Maximum Length:
700URL of the supplier's organization. -
ThumbnailImageURL: string
Maximum Length:
700Location of the small version of a larger image file for the item specified on the blanket purchase agreement. -
UNNumber: string
Title:
UN NumberRead Only:trueMaximum Length:20Number that the United Nations uses to identify hazardous material. -
UNNumberDescription: string
Title:
UN Number DescriptionRead Only:trueMaximum Length:240Description of the hazardous material that the United Nations identification number references. -
UNNumberId: integer
(int64)
Read Only:
trueValue that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UNSPSC: string
Maximum Length:
700The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
arrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:240Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
AttributeValuesId: integer
(int64)
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
AgreementLineId: integer
(int64)
Read Only:
trueValue that uniquely identifies the agreement line. -
attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CancelFlag: boolean
Read Only:
trueMaximum Length:1Contains 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:
trueMaximum Length:64User who created the price breaks for a purchase agreement line. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the price breaks for a purchase agreement line. -
Currency: string
Title:
Currency NameRead Only:trueMaximum Length:80Currency on the agreement line price break. -
CurrencyCode: string
Read Only:
trueMaximum Length:15Code 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:
trueMaximum Length:1Value that identifies if the row is new or changed. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate when the price break was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the price breaks on a purchase agreement line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Location: string
Title:
LocationMaximum Length:240Name of the location where the supplier ships the item. -
LocationCode: string
Title:
NameMaximum Length:60Abbreviation 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:
trueCount of attachments associated with the price break of an agreement line. -
NumberOfPriceBreakSupplierAttachments: integer
(int64)
Read Only:
trueURL of the attachment associated with the item. -
Price: number
Price of the price break.
-
PriceBreakId: integer
(int64)
Read Only:
trueValue 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:
240Value that identifies the reason for changing the agreement price break. -
ShipToOrganization: string
Title:
Ship-to OrganizationMaximum Length:240Name of the inventory organization that receives the item. -
ShipToOrganizationCode: string
Maximum Length:
18Abbreviation 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 NameRead Only:trueMaximum Length:25Abbreviation that identifies the unit of measure on the agreement line price break. -
UOMCode: string
Maximum Length:
3Code that identifies the unit of measure.
arrayAttachmentsarrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
LineLocationId: integer
(int64)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
arrayLinksobject-
Amount: number
Notification amount of purchase agreement document total.
-
Condition: string
Title:
ConditionMaximum Length:80Notification type of the purchase agreement. -
ConditionCode: string
Maximum Length:
25Notification type of the purchase agreement. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the notification controls on the purchase agreement. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application created the notification controls of a purchase agreement. -
DFF: array
DFF
-
EndDate: string
(date)
Expiration date of the notification.
-
EntityChangeTypeCode: string
Read Only:
trueMaximum Length:1Value that identifies if the row is new or changed. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the buyer or application last updated the notification controls of a purchase agreement. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who last updated the notification controls of a purchase agreement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NotificationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the agreement notification control. -
Percentage: number
Notification percentage of purchase agreement document total.
-
ReminderDays: number
Title:
Reminder DaysValue that identifies the number of days before the expiration event that the reminder notification needs to be sent. -
StartDate: string
(date)
Effective date of the notification.
arrayLinksobject-
__FLEX_Context: string
Title:
Context PromptMaximum Length:30Context Prompt -
__FLEX_Context_DisplayValue: string
Title:
Context PromptContext Prompt -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NotificationId: integer
(int64)
arrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAsynchronous tracker ID of the supporting document. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the supporting document. -
CategoryName: string
Title:
CategoryMaximum Length:30Code for the category to which the supporting document is assigned. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies if the supporting document is a file or a URL. -
Description: string
Title:
DescriptionMaximum Length:255Description of the supporting document. -
DmDocumentId: string
Maximum Length:
255Document identifier of the supporting document in the content server. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Path of the folder for the supporting document in the content server. -
DmVersionNumber: string
Maximum Length:
255Version number of the supporting document in the content server. -
DownloadInfo: string
Title:
DownloadInfoJSON object, represented as a string, containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the supporting document. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the supporting document. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the supporting document. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the supporting document. -
FileName: string
Title:
File NameMaximum Length:2048File name of the supporting document. A file name or URL is required. -
FileUrl: string
Title:
File UrlURL location of the supporting document. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueBase64-encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueDate when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionName of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleTitle of the supporting document. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type of the supporting document. -
UploadedFileLength: integer
Title:
File SizeUploaded file length of the supporting document. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name of the supporting document. -
UploadedText: string
Title:
Uploaded TextUploaded text of the supporting document. -
Uri: string
Title:
UriMaximum Length:4000URI of the supporting document. -
Url: string
Title:
UrlMaximum Length:4000URL of the supporting document. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Name of the category to which the supporting document is assigned.
arrayLinksobject-
AuthoringParty: string
Maximum Length:
255Indicates which party was the author of the contract terms for the document. -
AuthoringPartyCode: string
Title:
Authoring PartyMaximum Length:30Code that indicates which party was the author of the contract terms for the document. -
ContractExpertEnabled: string
Read Only:
trueMaximum Length:1Indicates whether the contract expert feature can be used after the contract template is applied to a business document. Possible values are Y and N. -
ContractFormAttachment: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
ContractSourceCode: string
Title:
Contract SourceMaximum Length:30Indicates the current source of the contract terms for the business document. Valid values are STRUCTURED and ATTACHED. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Read Only:
trueDate and time of the creation of the record. -
Description: string
Read Only:
trueMaximum Length:2000Description of the contract template used in the business document. -
DocumentNumber: string
Title:
Document NumberMaximum Length:150Number of the business document that's associated with a contract template. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Sign in of the user who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SimpleContractText: string
(byte)
HTML content of the simple contract terms.
-
SimpleContractYn: string
Maximum Length:
1Indicates whether the contract is simple. -
SourceCode: string
Read Only:
trueMaximum Length:80Source of the template. Possible values are STRUCTURED and ATTACHED. -
TemplateId: number
Title:
Contract Terms TemplateUnique identifier for the contract template used in the business document. -
TemplateName: string
Title:
Current Contract Terms TemplateRead Only:trueMaximum Length:240Name of the contract template used in the business document.
arrayAttachmentsarrayLinksobject-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
arrayLinks- DFF
-
Operation: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/DFFParameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
- draftPurchaseAgreementsUniqID:
- addContractTerms
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Adds contract terms to a business document. When you add contract terms, the business document is updated to reflect the contract terms. - draftPurchaseAgreementsUniqID:
- applyLatestTemplate
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Applies latest terms to a business document. This action retrieves and applies the latest terms template version from the terms library to the business document. This action can performed only when the contract source is a terms template. - draftPurchaseAgreementsUniqID:
- attachments
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
The attachments resource is used to view, create, and update attachments. - draftPurchaseAgreementsUniqID:
- businessUnitAccess
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Agreement business unit access contains mapping for client requisitioning business units that can make purchases using the agreement. For example, a blanket purchase agreement with supplier Advanced Network Devices is hosted by Vision Operations, and is made available to Vision Services where Vision Operations provides the procurement service for all requisitions created by its client, Vision Services. - draftPurchaseAgreementsUniqID:
- cancelChangeOrder
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Cancel one change order - draftPurchaseAgreementsUniqID:
- changeContractSource
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Changes contract source on a business document. When you change contract source, the business document is updated to reflect the contract terms from new contract source. For example, you change the contract source on a purchase order from Terms Template to Attached Document. - draftPurchaseAgreementsUniqID:
- contractDocuments
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Details of the contract document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. - draftPurchaseAgreementsUniqID:
- deleteChangeOrder
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Delete an incomplete change order - draftPurchaseAgreementsUniqID:
- downloadLinesResources
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Download resources for agreement lines. - draftPurchaseAgreementsUniqID:
- eSign
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Initiates and manages the e-signature process for a purchase agreement or change order using Docusign integration. E-signature actions include preparing for the e-signature, updating the document status, managing e-signatures, and tracking e-signature history. - draftPurchaseAgreementsUniqID:
- lines
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Details of the goods or services to be purchased from the supplier. The line doesn't contain delivery dates or individual delivery quantities or amounts. For example, an agreement line can be service-based for installing a television or a goods item to negotiate the price for 50 laptops. - draftPurchaseAgreementsUniqID:
- notificationControls
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Agreement notification control alerts the user when expiration and release control conditions are met for an agreement. For example, it could send an expiration notification when an agreement expires or a released amount notification when the agreement amount is released. - draftPurchaseAgreementsUniqID:
- removeContractTerms
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Removes contract terms from a business document. When you perform this action, contract terms and all associated contract documents are removed from the business document. - draftPurchaseAgreementsUniqID:
- submit
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Submit one draft purchase agreement - draftPurchaseAgreementsUniqID:
- supportingDocuments
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Details of the supporting document associated with the contract terms of a purchasing document. The information includes the file name, title, description, and category. - draftPurchaseAgreementsUniqID:
- templateUsages
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
The relationship between a contract template and the business document in which it's used. For example, the Subcontracting Terms and Conditions contract template is used in the purchase agreement 11001. - draftPurchaseAgreementsUniqID:
- transferAuthoring
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Transfer authoring of a blanket purchase agreement from buyer to catalog administrator or supplier, or from catalog administrator or supplier back to buyer. - draftPurchaseAgreementsUniqID:
- validateDocument
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
If the request is successful, this action returns a list of errors or warnings prior to submitting the purchase agreement. - draftPurchaseAgreementsUniqID:
- viewMasterContract
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Downloads PDF content of the master contract in Base64 format. - draftPurchaseAgreementsUniqID:
- viewPDF
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Download PDF content of one purchase agreement - draftPurchaseAgreementsUniqID:
- withdraw
-
Parameters:
- draftPurchaseAgreementsUniqID:
$request.path.draftPurchaseAgreementsUniqID
Withdraw one purchase agreement or a change order from approval - draftPurchaseAgreementsUniqID:
Examples
A draft purchase agreement or an approved purchase agreement can be updated using PATCH operation. To initiate a change on an approved purchase agreement as a buyer, change order description and change order initiating party are required.
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/draftPurchaseOrdersUniqID"
Examples
Table - Examples
| Examples Number | Description |
|---|---|
| Example 1 | Update a draft contract purchase agreement header as a buyer. |
| Example 2 | Update an approved blanket purchase agreement for goods and services lines with change order initiating party as buyer. |
| Example 3 | Update an approved blanket purchase agreement for price break with change order initiating party as buyer. |
| Example 4 | Update the business unit access in draft blanket purchase agreement header as a buyer. |
| Example 5 | Update the order processing attributes in approved blanket purchase agreement with change order initiating party as buyer. |
| Example 6 | Update the alerts in approved contract purchase agreement with change order initiating party as buyer. |
| Example 7 | Update descriptive flexfields on an approved purchase order with change order initiating party as buyer. |
| Example 8 | Update an approved blanket purchase agreement line and add a new goods line with change order initiating party as buyer. |
| Example 9 | Update an approved price break and add a new price break with change order initiating party as buyer. |
Example 1 cURL Command
Update a draft contract purchase agreement header as a buyer.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658"
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.
{
"AgreementAmount": 1200000,
"AmountLimit": 1500000,
"MinimumReleaseAmount": 15000,
"EndDate": "2027-12-31"
}
Example1 Response Body
{
"AgreementHeaderId": 300100648116658,
"AgreementNumber": "1003068",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863783,
"Buyer": "Furey,Clare",
"BuyerFullName": "Clare Furey",
"DocumentStyleId": 1,
"DocumentStyle": "Contract Purchase Agreement",
"StatusCode": "INCOMPLETE",
"Status": "Incomplete",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": 300100559967561,
"SupplierContact": "Diaz, Carlos",
"SupplierContactFullName": "Carlos Diaz",
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2027-12-31",
"AgreementAmount": 1200000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1500000,
"MinimumReleaseAmount": 15000,
"Description": "Agreement for FY 2025-26 for maintenance supplies",
"DocumentTypeCode": "CONTRACT",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": true,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-16T07:22:32.042+00:00",
"CreatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-16T07:22:32.042+00:00",
"LastUpdatedBy": "CVBUYER01",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": null,
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": null,
"EntityChangeTypeCode": "I",
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100648116658_300100648116659_0",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": null,
"ChangeOrderInitiatingParty": null,
"ChangeOrderDescription": null,
"ChangeOrderStatus": null,
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": null,
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Contract Purchase Agreement",
"BuyerEmail": "clare.furey@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648116658/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}Example 2 cURL Command
Update an approved blanket purchase agreement for goods and services lines with change order initiating party as buyer
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100648090881"
Example 2 Request Body
The following example includes the contents of the request body in JSON format to update a approved blanket purchase agreement goods line and service line with change order initiating party as buyer. 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.
{
"ChangeOrderDescription": "extension of BPA and price updates" ,
"ChangeOrderInitiatingParty": "BUYER" ,
"RequiredAcknowledgmentCode": "D" ,
"AcknowledgmentWithinDays": 7 ,
"EndDate": "2027-12-31" ,
"lines": [
{
"AgreementLineId": 300100648090883 ,
"Price": 35 ,
"PriceLimit": 45 ,
"ExpirationDate": "2027-07-31"
},
{
"AgreementLineId": 300100648090884 ,
"Amount": 9.99 ,
"ExpirationDate": "2027-12-31"
}
]
}
Example 2 Response Body
The following example includes the contents of the request body in JSON format to update a approved blanket purchase agreement goods line and service line with change order initiating party as buyer. 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.
{
"AgreementHeaderId": 300100648090881,
"AgreementNumber": "1003070",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863783,
"Buyer": "Furey,Clare",
"BuyerFullName": "Clare Furey",
"DocumentStyleId": 1,
"DocumentStyle": "Blanket Purchase Agreement",
"StatusCode": "OPEN",
"Status": "Open",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": null,
"SupplierContact": null,
"SupplierContactFullName": null,
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2027-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": null,
"Description": null,
"DocumentTypeCode": "BLANKET",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "D",
"RequiredAcknowledgment": "Document",
"AcknowledgmentDueDate": "2026-04-23",
"AcknowledgmentWithinDays": 7,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": true,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-16T09:23:11.342+00:00",
"CreatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-16T09:23:11.342+00:00",
"LastUpdatedBy": "CVBUYER01",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": "1",
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": "INCOMPLETE",
"EntityChangeTypeCode": null,
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100648090881_300100648116767_0",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": "Clare Furey",
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": "extension of BPA and price updates",
"ChangeOrderStatus": "Incomplete",
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": "Buyer",
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Blanket Purchase Agreement",
"BuyerEmail": "clare.furey@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"lines": [
{
"AgreementLineId": 300100648090883,
"LineNumber": 1,
"AgreementHeaderId": 300100648090881,
"LineTypeId": 1,
"LineType": "Goods",
"ItemId": 663907,
"Item": "RCV-100",
"ItemRevision": null,
"Description": "Plain Item",
"SupplierItem": null,
"CategoryId": 1,
"CategoryCode": "MISC.MISC",
"Category": "Miscellaneous_1",
"StatusCode": "OPEN",
"Status": "Open",
"UOMCode": "Ea",
"UOM": "Each",
"Price": 35,
"Amount": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"ConsignmentLineFlag": false,
"NoteToSupplier": null,
"AllowItemDescriptionUpdateFlag": true,
"PriceLimit": 45,
"AllowPriceOverrideFlag": true,
"NegotiatedFlag": null,
"LineStartDate": "2026-01-01",
"ExpirationDate": "2027-07-31",
"MinimumReleaseAmount": null,
"AgreementAmount": null,
"AgreementQuantity": null,
"PriceBreakTypeCode": "CUMULATIVE",
"ParentItemId": null,
"ParentItem": null,
"SupplierParentItem": null,
"TopModelId": null,
"TopModel": null,
"SupplierTopModel": null,
"SupplierPartAuxid": null,
"UNNumberId": null,
"UNNumber": null,
"UNNumberDescription": null,
"HazardClassId": null,
"HazardClassCode": null,
"HazardClass": null,
"AgingPeriodDays": null,
"CreatedBy": "CVBUYER01",
"CreationDate": "2026-04-16T09:23:10.932+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-16T09:23:10.932+00:00",
"Negotiation": null,
"PurchaseBasis": "GOODS",
"PriceBreakType": "Cumulative",
"ItemAllowItemDescriptionUpdateFlag": true,
"IsLineApprovedOnceFlag": true,
"CancelReason": null,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"CancelledBy": null,
"ReceivedQuantity": null,
"ReceivedAmount": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"DeliveredQuantity": null,
"DeliveredAmount": null,
"ReleasedQuantity": null,
"AmountReleased": null,
"ComponentQuantityReleased": null,
"ComponentAmountReleased": null,
"PurchaseOrdersCreated": 0,
"RejectedReason": null,
"AcknowledgeResponseCode": null,
"PimItemCategoryId": 1,
"PimItemDescription": "Plain Item",
"PimItemCategoryCode": "MISC.MISC",
"PimItemCategory": "Miscellaneous_1",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/itemAttributes",
"name": "itemAttributes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/action/undoChanges",
"name": "undoChanges",
"kind": "other"
}
]
},
{
"AgreementLineId": 300100648090884,
"LineNumber": 2,
"AgreementHeaderId": 300100648090881,
"LineTypeId": 6,
"LineType": "Fixed Price Services",
"ItemId": null,
"Item": null,
"ItemRevision": null,
"Description": "Support services",
"SupplierItem": null,
"CategoryId": 1,
"CategoryCode": "MISC.MISC",
"Category": "Miscellaneous_1",
"StatusCode": "OPEN",
"Status": "Open",
"UOMCode": null,
"UOM": null,
"Price": null,
"Amount": 9.99,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"ConsignmentLineFlag": false,
"NoteToSupplier": null,
"AllowItemDescriptionUpdateFlag": null,
"PriceLimit": null,
"AllowPriceOverrideFlag": true,
"NegotiatedFlag": null,
"LineStartDate": "2026-01-01",
"ExpirationDate": "2027-12-31",
"MinimumReleaseAmount": null,
"AgreementAmount": null,
"AgreementQuantity": null,
"PriceBreakTypeCode": null,
"ParentItemId": null,
"ParentItem": null,
"SupplierParentItem": null,
"TopModelId": null,
"TopModel": null,
"SupplierTopModel": null,
"SupplierPartAuxid": null,
"UNNumberId": null,
"UNNumber": null,
"UNNumberDescription": null,
"HazardClassId": null,
"HazardClassCode": null,
"HazardClass": null,
"AgingPeriodDays": null,
"CreatedBy": "CVBUYER01",
"CreationDate": "2026-04-16T09:23:10.985+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-16T09:23:10.985+00:00",
"Negotiation": null,
"PurchaseBasis": "SERVICES",
"PriceBreakType": null,
"ItemAllowItemDescriptionUpdateFlag": null,
"IsLineApprovedOnceFlag": true,
"CancelReason": null,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"CancelledBy": null,
"ReceivedQuantity": null,
"ReceivedAmount": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"DeliveredQuantity": null,
"DeliveredAmount": null,
"ReleasedQuantity": null,
"AmountReleased": null,
"ComponentQuantityReleased": null,
"ComponentAmountReleased": null,
"PurchaseOrdersCreated": 0,
"RejectedReason": null,
"AcknowledgeResponseCode": null,
"PimItemCategoryId": null,
"PimItemDescription": null,
"PimItemCategoryCode": null,
"PimItemCategory": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884/child/itemAttributes",
"name": "itemAttributes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090884/action/undoChanges",
"name": "undoChanges",
"kind": "other"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 3 cURL Command
Update an approved blanket purchase agreement for price break with change order initiating party as buyer
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100650911636"
Example 3 Request Body
The following example includes the contents of the request body in JSON format to update price break for an approved blanket purchase agreement line with change order initiating party as buyer. 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.
{
"ChangeOrderDescription": "update price break",
"ChangeOrderInitiatingParty": "BUYER",
"lines": [
{
"AgreementLineId": 300100650911638,
"priceBreaks": [
{
"PriceBreakId": 300100650911639,
"PriceBreakNumber": 1,
"ShipToOrganization": "Vision Operations",
"Location": "New York/ Yonkers City",
"DiscountPercent": 17.5
},
{
"PriceBreakId": 300100650911640,
"PriceBreakNumber": 2,
"Quantity": 1500,
"Price": 7.5
}
]
}
]
}
Response Body
{
"AgreementHeaderId": 300100650911636,
"AgreementNumber": "0008792",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863855,
"Buyer": "Quam,Ericka",
"BuyerFullName": "Ericka Quam",
"DocumentStyleId": 1,
"DocumentStyle": "Blanket Purchase Agreement",
"StatusCode": "WITHDRAWN",
"Status": "Withdrawn",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": null,
"SupplierContact": null,
"SupplierContactFullName": null,
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": null,
"Description": null,
"DocumentTypeCode": "BLANKET",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": true,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": false,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-30T05:51:57.038+00:00",
"CreatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-30T05:51:57.038+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": "0-1",
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": "INCOMPLETE",
"EntityChangeTypeCode": null,
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100650911636_300100650911662_0",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": "Ericka Quam",
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": "update price break",
"ChangeOrderStatus": "Incomplete",
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": "Buyer",
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Blanket Purchase Agreement",
"BuyerEmail": "sendmail-test-discard@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"lines": [
{
"AgreementLineId": 300100650911638,
"LineNumber": 1,
"AgreementHeaderId": 300100650911636,
"LineTypeId": 1,
"LineType": "Goods",
"ItemId": 663907,
"Item": "RCV-100",
"ItemRevision": null,
"Description": "Plain Item Test",
"SupplierItem": null,
"CategoryId": 2920,
"CategoryCode": "CAPITAL.EQUIPMENT",
"Category": "Capital Equipment",
"StatusCode": "WITHDRAWN",
"Status": null,
"UOMCode": "Ea",
"UOM": "Each",
"Price": 10,
"Amount": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"ConsignmentLineFlag": false,
"NoteToSupplier": null,
"AllowItemDescriptionUpdateFlag": true,
"PriceLimit": 15,
"AllowPriceOverrideFlag": true,
"NegotiatedFlag": null,
"LineStartDate": null,
"ExpirationDate": "2026-07-31",
"MinimumReleaseAmount": null,
"AgreementAmount": null,
"AgreementQuantity": null,
"PriceBreakTypeCode": "CUMULATIVE",
"ParentItemId": null,
"ParentItem": null,
"SupplierParentItem": null,
"TopModelId": null,
"TopModel": null,
"SupplierTopModel": null,
"SupplierPartAuxid": null,
"UNNumberId": null,
"UNNumber": null,
"UNNumberDescription": null,
"HazardClassId": null,
"HazardClassCode": null,
"HazardClass": null,
"AgingPeriodDays": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-04-30T05:32:07.145+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-30T05:32:07.145+00:00",
"Negotiation": null,
"PurchaseBasis": "GOODS",
"PriceBreakType": "Cumulative",
"ItemAllowItemDescriptionUpdateFlag": true,
"IsLineApprovedOnceFlag": true,
"CancelReason": null,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"CancelledBy": null,
"ReceivedQuantity": null,
"ReceivedAmount": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"DeliveredQuantity": null,
"DeliveredAmount": null,
"ReleasedQuantity": null,
"AmountReleased": null,
"ComponentQuantityReleased": null,
"ComponentAmountReleased": null,
"PurchaseOrdersCreated": 0,
"RejectedReason": null,
"AcknowledgeResponseCode": null,
"PimItemCategoryId": 2920,
"PimItemDescription": "Plain Item Test",
"PimItemCategoryCode": "CAPITAL.EQUIPMENT",
"PimItemCategory": "Capital Equipment",
"priceBreaks": [
{
"PriceBreakId": 300100650911639,
"PriceBreakNumber": 1,
"AgreementLineId": 300100650911638,
"ShipToOrganizationId": 204,
"ShipToOrganizationCode": "V1",
"ShipToOrganization": "Vision Operations",
"LocationId": 300100073052077,
"LocationCode": "New York/ Yonkers City",
"Location": "New York/ Yonkers City",
"Quantity": null,
"UOMCode": "Ea",
"UOM": "Each",
"Price": 8.2500000000,
"DiscountPercent": 17.5,
"StartDate": null,
"EndDate": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-04-30T05:51:55.624+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-30T05:51:55.624+00:00",
"NumberOfPriceBreakAttachments": 0,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"NumberOfPriceBreakSupplierAttachments": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911639",
"name": "priceBreaks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911639",
"name": "priceBreaks",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638",
"name": "lines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911639/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911639/child/attachments",
"name": "attachments",
"kind": "collection"
}
]
},
{
"PriceBreakId": 300100650911640,
"PriceBreakNumber": 2,
"AgreementLineId": 300100650911638,
"ShipToOrganizationId": null,
"ShipToOrganizationCode": null,
"ShipToOrganization": null,
"LocationId": null,
"LocationCode": null,
"Location": null,
"Quantity": 1500,
"UOMCode": "Ea",
"UOM": "Each",
"Price": 7.5,
"DiscountPercent": 25.00000,
"StartDate": null,
"EndDate": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-04-30T05:51:55.636+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-30T05:51:55.636+00:00",
"NumberOfPriceBreakAttachments": 0,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"NumberOfPriceBreakSupplierAttachments": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911640",
"name": "priceBreaks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911640",
"name": "priceBreaks",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638",
"name": "lines",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911640/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks/300100650911640/child/attachments",
"name": "attachments",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/itemAttributes",
"name": "itemAttributes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines/300100650911638/action/undoChanges",
"name": "undoChanges",
"kind": "other"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911636/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 4 cURL Command
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100648090881"
Example 4 Request Body
The following example includes the contents of the request body in JSON format to update Bill to BU and Bill to Location for business unit access in draft blanket purchase agreement header as a buyer. 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.
{
"ChangeOrderDescription": "update of business unit details" ,
"ChangeOrderInitiatingParty": "BUYER" ,
"businessUnitAccess": [
{
"BilltoBUId": 5186 ,
"BillToLocation": "AD1-Vision A&D Final Assy Plant 1"
}
]
}
Response Body
{
"AgreementHeaderId": 300100648090881,
"AgreementNumber": "1003070",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863783,
"Buyer": "Furey,Clare",
"BuyerFullName": "Clare Furey",
"DocumentStyleId": 1,
"DocumentStyle": "Blanket Purchase Agreement",
"StatusCode": "OPEN",
"Status": "Open",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": null,
"SupplierContact": null,
"SupplierContactFullName": null,
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": null,
"Description": null,
"DocumentTypeCode": "BLANKET",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": true,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-16T09:23:11.342+00:00",
"CreatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-16T11:06:57.956+00:00",
"LastUpdatedBy": "CVBUYER01",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": null,
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": null,
"EntityChangeTypeCode": null,
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100648090881_300100648090882_3",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": null,
"ChangeOrderInitiatingParty": null,
"ChangeOrderDescription": null,
"ChangeOrderStatus": null,
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": null,
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Blanket Purchase Agreement",
"BuyerEmail": "clare.furey@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000B78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 5 cURL Command
Update the order processing attributes in approved blanket purchase agreement with change order initiating party as buyer.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100648090881"
Example 5 Request Body
The following example includes the contents of the request body in JSON format to update order processing attributes like Retroactive Pricing, Priority, Use Order Date for Order Pricing for a approved blanket purchase agreement with change order initiating party as buyer. 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.
{
"ChangeOrderInitiatingParty" : "BUYER" ,
"ChangeOrderDescription" : "updating the processing conditions" ,
"UseOrderDateForOrderPricingFlag" : true ,
"InitiateRetroactivePricingUponApprovalFlag" : true ,
"RepriceOpenOrdersFlag" : true ,
"CommunicateRepricedOrdersFlag" : false ,
"Priority" : 11
}
Example 5 Response Body
{
"AgreementHeaderId": 300100650911753,
"AgreementNumber": "0008794",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863855,
"Buyer": "Quam,Ericka",
"BuyerFullName": "Ericka Quam",
"DocumentStyleId": 1,
"DocumentStyle": "Blanket Purchase Agreement",
"StatusCode": "OPEN",
"Status": "Open",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": null,
"SupplierContact": null,
"SupplierContactFullName": null,
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": null,
"Description": null,
"DocumentTypeCode": "BLANKET",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": false,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": true,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": true,
"Priority": 11,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-30T06:34:36.175+00:00",
"CreatedBy": "CVBUYER01",
"LastUpdateDate": "2026-04-30T06:34:36.175+00:00",
"LastUpdatedBy": "CVBUYER01",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": "1",
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": "INCOMPLETE",
"EntityChangeTypeCode": null,
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100650911753_300100650932806_0",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": "Clare Furey",
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": "updating the processing conditions",
"ChangeOrderStatus": "Incomplete",
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": "Buyer",
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Blanket Purchase Agreement",
"BuyerEmail": "sendmail-test-discard@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100650911753/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 6 cURL Command
Update the alerts in approved contract purchase agreement with change order initiating party as buyer.
Example 6 Request Body
The following example includes the contents of the request body in JSON format to update undertilized alert and expiration alert for an approved contract purchase agreement with change order initiating party as buyer. 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.
{
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": "updating the alerts conditions",
"notificationControls": [
{
"NotificationId": 300100648090482,
"Condition": "Amount Not Released",
"Percentage": 30
},
{
"NotificationId": 300100648090483,
"Condition": "Expiration",
"ReminderDays": 30
}
]
}
Response Body
{
"AgreementHeaderId": 300100648090480,
"AgreementNumber": "1003085",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863783,
"Buyer": "Furey,Clare",
"BuyerFullName": "Clare Furey",
"DocumentStyleId": 1,
"DocumentStyle": "Contract Purchase Agreement",
"StatusCode": "OPEN",
"Status": "Open",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": 300100559967561,
"SupplierContact": "Diaz, Carlos",
"SupplierContactFullName": "Carlos Diaz",
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": 5000,
"Description": "Agreement for FY 2025-26 for maintenance supplies",
"DocumentTypeCode": "CONTRACT",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": true,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-04-16T11:16:46.669+00:00",
"CreatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-16T11:16:46.669+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": "1",
"ChangeOrderSequence": null,
"VersionId": null,
"ChangeOrderStatusCode": "INCOMPLETE",
"EntityChangeTypeCode": null,
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100648090480_300100648116997_0",
"CancelDocumentFlag": null,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": null,
"ChangeRequestedBy": "Clare Furey",
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": "updating the alerts conditions",
"ChangeOrderStatus": "Incomplete",
"ChangeOrderType": null,
"ChangeOrderCreationDate": null,
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": "Buyer",
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Contract Purchase Agreement",
"BuyerEmail": "clare.furey@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": null,
"notificationControls": [
{
"NotificationId": 300100648090482,
"ConditionCode": "AMOUNT NOT RELEASED",
"Percentage": 30,
"Amount": 300000,
"StartDate": "2026-12-15",
"EndDate": "2026-12-15",
"ReminderDays": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-04-16T11:16:46.510+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-16T11:16:46.510+00:00",
"Condition": "Amount Not Released",
"EntityChangeTypeCode": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090482",
"name": "notificationControls",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090482",
"name": "notificationControls",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090482/child/DFF",
"name": "DFF",
"kind": "collection"
}
]
},
{
"NotificationId": 300100648090483,
"ConditionCode": "EXPIRATION",
"Percentage": null,
"Amount": null,
"StartDate": "2026-12-01",
"EndDate": "2026-12-31",
"ReminderDays": 30,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-04-16T11:16:46.518+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-04-16T11:16:46.518+00:00",
"Condition": "Expiration",
"EntityChangeTypeCode": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090483",
"name": "notificationControls",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090483",
"name": "notificationControls",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls/300100648090483/child/DFF",
"name": "DFF",
"kind": "collection"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000978"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090480/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 8 cURL Command
Update an approved blanket purchase agreement line and add a new goods line with change order initiating party as buyer.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100648090881"
Example 8 Request Body
The following example includes the contents of the request body in JSON format to update an approved blanket purchase agreement line and add a new goods line with change order initiating party as buyer. 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.
{
"AgreementHeaderId": 300100648090881,
"lines" :
[
{
"AgreementLineId": 300100648090883,
"LineNumber": 1,
"Price": 10,
"NoteToSupplier": "hazadous material to be shipped after NOC",
"PriceLimit": 18
},
{
"LineNumber": 4,
"LineType": "Goods",
"Item": "RCV-110",
"UOM": "Each",
"Price": 99,
"PriceBreakTypeCode": "CUMULATIVE",
"PriceLimit": 110,
"AllowPriceOverrideFlag": true,
"AgreementAmount": 990000,
"MinimumReleaseAmount": 100
}
]
}
Example 8 Response Body
{
"AgreementHeaderId": 300100648090881,
"AgreementNumber": "1003070",
"ProcurementBUId": 204,
"ProcurementBU": "Vision Operations",
"BuyerId": 100010026863783,
"Buyer": "Furey, Clare",
"BuyerFullName": "Clare Furey",
"DocumentStyleId": 1,
"DocumentStyle": "Blanket Purchase Agreement",
"StatusCode": "OPEN",
"Status": "Open",
"SupplierId": 300100559967512,
"Supplier": "Tall Manufacturing",
"SupplierPartyId": 300100559967510,
"SupplierSiteId": 300100559967535,
"SupplierSite": "Philadelphia",
"SupplierContactId": null,
"SupplierContact": null,
"SupplierContactFullName": null,
"SupplierCommunicationMethodCode": "NONE",
"SupplierEmailAddress": null,
"SupplierFax": null,
"StartDate": "2026-01-01",
"EndDate": "2026-12-31",
"AgreementAmount": 1000000,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"AmountLimit": 1000000,
"MinimumReleaseAmount": null,
"Description": null,
"DocumentTypeCode": "BLANKET",
"MasterContractId": null,
"MasterContractNumber": null,
"SupplierAgreement": null,
"ReferenceNumber": null,
"RequiredAcknowledgmentCode": "N",
"RequiredAcknowledgment": "None",
"AcknowledgmentDueDate": null,
"AcknowledgmentWithinDays": null,
"PaymentTermsId": 10003,
"PaymentTerms": "45 Net (terms date + 45)",
"CarrierId": 12519,
"Carrier": "Airborne",
"ModeOfTransportCode": "PARCEL",
"ModeOfTransport": "Parcel",
"ServiceLevelCode": "LTL",
"ServiceLevel": "Standard",
"FreightTermsCode": "Due",
"FreightTerms": "Due",
"FOBCode": "Origin",
"FOB": "Origin",
"RequiresSignatureFlag": false,
"BuyerManagedTransportFlag": false,
"PayOnReceiptFlag": true,
"ConfirmingOrderFlag": false,
"ConsumptionAdviceFrequencyCode": null,
"ConsumptionAdviceFrequency": null,
"ConsumptionAdviceSummaryCode": null,
"ConsumptionAdviceSummary": null,
"AgingOnsetPointCode": null,
"AgingOnsetPoint": null,
"AgingPeriodDays": null,
"NoteToReceiver": null,
"NoteToSupplier": null,
"AutomaticallyGenerateOrdersFlag": false,
"AutomaticallySubmitForApprovalFlag": false,
"GroupRequisitionsFlag": false,
"UseCustomerSalesOrderFlag": false,
"UseShipToLocationFlag": false,
"GroupRequisitionLinesFlag": false,
"UseRequestedDateFlag": false,
"UseShipToOrganizationAndLocationFlag": false,
"AllowUnassignedSitesFlag": false,
"EnableRetroactivePricingFlag": false,
"InitiateRetroactivePricingUponApprovalFlag": false,
"RepriceOpenOrdersFlag": false,
"CommunicateRepricedOrdersFlag": false,
"PunchoutRequestsOnlyFlag": false,
"UseOrderDateForOrderPricingFlag": false,
"Priority": null,
"ChecklistId": null,
"Checklist": null,
"ChecklistNumber": null,
"CreationDate": "2026-05-04T10:15:24.540+00:00",
"CreatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-05-04T10:15:24.540+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"PayOnUseFlag": false,
"DefaultConsignmentLineFlag": false,
"BillingCycleClosingDate": null,
"ChangeOrderNumber": "1",
"ChangeOrderSequence": 10000,
"VersionId": 300100648273596,
"ChangeOrderStatusCode": "INCOMPLETE",
"EntityChangeTypeCode": "U",
"DocumentCreationMethod": "PA_REST_SERVICE",
"AutoSourcingFlag": false,
"IdentificationKey": "PA_300100648090881_300100648273596_0",
"CancelDocumentFlag": false,
"ScheduleGroup": null,
"ContractTermsExists": null,
"PriceUpdateTolerance": null,
"NegotiationId": null,
"Negotiation": null,
"ConfiguredItemFlag": false,
"OutsideProcessingFlag": false,
"ConsignedItemsFlag": false,
"PriceBreaksFlag": true,
"NoteToAuthorizer": null,
"LatestIdentificationKey": null,
"ScheduleGroupMeaning": null,
"ChangeOrderTypeCode": "I",
"ChangeRequestedBy": "Clare Furey",
"ChangeOrderInitiatingParty": "BUYER",
"ChangeOrderDescription": " ",
"ChangeOrderStatus": "Incomplete",
"ChangeOrderType": "External",
"ChangeOrderCreationDate": "2026-04-17T06:42:22+00:00",
"ReleasedAmount": null,
"ChangeOrderInitiatorRole": "Buyer",
"OkcContractNumber": null,
"OkcContractId": null,
"SupplierPayOnUseFlag": null,
"DocumentType": "Blanket Purchase Agreement",
"BuyerEmail": "clare.furey@oracle.com",
"ShippingMethod": "Airborne-Parcel-Standard",
"MasterContractTypeId": null,
"MasterContractType": null,
"ChangeOrderInitiatorId": 100010026863783,
"lines": [
{
"AgreementLineId": 300100648090883,
"LineNumber": 1,
"AgreementHeaderId": 300100648090881,
"LineTypeId": 1,
"LineType": "Goods",
"ItemId": 663907,
"Item": "RCV-100",
"ItemRevision": null,
"Description": "Plain Item",
"SupplierItem": null,
"CategoryId": 1,
"CategoryCode": "MISC.MISC",
"Category": "Miscellaneous_1",
"StatusCode": "OPEN",
"Status": "Open",
"UOMCode": "Ea",
"UOM": "Each",
"Price": 10,
"Amount": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"ConsignmentLineFlag": false,
"NoteToSupplier": "hazadous material to be shipped after NOC",
"AllowItemDescriptionUpdateFlag": true,
"PriceLimit": 18,
"AllowPriceOverrideFlag": true,
"NegotiatedFlag": null,
"LineStartDate": "2026-01-01",
"ExpirationDate": "2026-07-31",
"MinimumReleaseAmount": null,
"AgreementAmount": null,
"AgreementQuantity": null,
"PriceBreakTypeCode": "CUMULATIVE",
"ParentItemId": null,
"ParentItem": null,
"SupplierParentItem": null,
"TopModelId": null,
"TopModel": null,
"SupplierTopModel": null,
"SupplierPartAuxid": null,
"UNNumberId": null,
"UNNumber": null,
"UNNumberDescription": null,
"HazardClassId": null,
"HazardClassCode": null,
"HazardClass": null,
"AgingPeriodDays": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-05-04T10:15:23.431+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-05-04T10:15:23.430+00:00",
"Negotiation": null,
"PurchaseBasis": "GOODS",
"PriceBreakType": "Cumulative",
"ItemAllowItemDescriptionUpdateFlag": true,
"IsLineApprovedOnceFlag": true,
"CancelReason": null,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"CancelledBy": null,
"ReceivedQuantity": null,
"ReceivedAmount": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"DeliveredQuantity": null,
"DeliveredAmount": null,
"ReleasedQuantity": null,
"AmountReleased": null,
"ComponentQuantityReleased": null,
"ComponentAmountReleased": null,
"PurchaseOrdersCreated": 0,
"RejectedReason": null,
"AcknowledgeResponseCode": null,
"PimItemCategoryId": 2920,
"PimItemDescription": "Plain Item Test",
"PimItemCategoryCode": "CAPITAL.EQUIPMENT",
"PimItemCategory": "Capital Equipment",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/itemAttributes",
"name": "itemAttributes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100648090883/action/undoChanges",
"name": "undoChanges",
"kind": "other"
}
]
},
{
"AgreementLineId": 300100651840117,
"LineNumber": 4,
"AgreementHeaderId": 300100648090881,
"LineTypeId": 1,
"LineType": "Goods",
"ItemId": 663912,
"Item": "RCV-110",
"ItemRevision": null,
"Description": "LSR Item",
"SupplierItem": null,
"CategoryId": 1,
"CategoryCode": "MISC.MISC",
"Category": "Miscellaneous_1",
"StatusCode": null,
"Status": null,
"UOMCode": "Ea",
"UOM": "Each",
"Price": 99,
"Amount": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"ConsignmentLineFlag": false,
"NoteToSupplier": null,
"AllowItemDescriptionUpdateFlag": true,
"PriceLimit": 110,
"AllowPriceOverrideFlag": true,
"NegotiatedFlag": null,
"LineStartDate": null,
"ExpirationDate": null,
"MinimumReleaseAmount": 100,
"AgreementAmount": 990000,
"AgreementQuantity": null,
"PriceBreakTypeCode": "CUMULATIVE",
"ParentItemId": null,
"ParentItem": null,
"SupplierParentItem": null,
"TopModelId": null,
"TopModel": null,
"SupplierTopModel": null,
"SupplierPartAuxid": null,
"UNNumberId": 1,
"UNNumber": "NA1270",
"UNNumberDescription": "Petroleum oil",
"HazardClassId": 3,
"HazardClassCode": "3",
"HazardClass": "Flammable Liquid",
"AgingPeriodDays": null,
"CreatedBy": "PRC_INTEGRATION_USER",
"CreationDate": "2026-05-04T10:15:23.871+00:00",
"LastUpdatedBy": "PRC_INTEGRATION_USER",
"LastUpdateDate": "2026-05-04T10:15:23.871+00:00",
"Negotiation": null,
"PurchaseBasis": "GOODS",
"PriceBreakType": "Cumulative",
"ItemAllowItemDescriptionUpdateFlag": true,
"IsLineApprovedOnceFlag": false,
"CancelReason": null,
"CancelFlag": false,
"EntityChangeTypeCode": null,
"ReasonForChange": null,
"CancelledBy": null,
"ReceivedQuantity": null,
"ReceivedAmount": null,
"InvoicedQuantity": null,
"InvoicedAmount": null,
"DeliveredQuantity": null,
"DeliveredAmount": null,
"ReleasedQuantity": null,
"AmountReleased": null,
"ComponentQuantityReleased": null,
"ComponentAmountReleased": null,
"PurchaseOrdersCreated": null,
"RejectedReason": null,
"AcknowledgeResponseCode": null,
"PimItemCategoryId": 1,
"PimItemDescription": "LSR Item",
"PimItemCategoryCode": "MISC.MISC",
"PimItemCategory": "Miscellaneous_1",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117",
"name": "lines",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117",
"name": "lines",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117/child/itemAttributes",
"name": "itemAttributes",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines/300100651840117/action/undoChanges",
"name": "undoChanges",
"kind": "other"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000E78"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881",
"name": "draftPurchaseAgreements",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/attachments",
"name": "attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/businessUnitAccess",
"name": "businessUnitAccess",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/contractDocuments",
"name": "contractDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/lines",
"name": "lines",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/notificationControls",
"name": "notificationControls",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/supportingDocuments",
"name": "supportingDocuments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/child/templateUsages",
"name": "templateUsages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewPDF",
"name": "viewPDF",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/validateDocument",
"name": "validateDocument",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/removeContractTerms",
"name": "removeContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/viewMasterContract",
"name": "viewMasterContract",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/downloadLinesResources",
"name": "downloadLinesResources",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/submit",
"name": "submit",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/eSign",
"name": "eSign",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/addContractTerms",
"name": "addContractTerms",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/withdraw",
"name": "withdraw",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/applyLatestTemplate",
"name": "applyLatestTemplate",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/changeContractSource",
"name": "changeContractSource",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/cancelChangeOrder",
"name": "cancelChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/deleteChangeOrder",
"name": "deleteChangeOrder",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100648090881/action/transferAuthoring",
"name": "transferAuthoring",
"kind": "other"
}
]
}
Example 9 cURL Command
Update an approved price break and add a new price break with change order initiating party as buyer.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/draftPurchaseOrders/300100651109637"
Example 9 Request Body
The following example includes the contents of the request body in JSON format to update an approved blanket purchase agreement line and add a new goods line with change order initiating party as buyer. 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.
{
"AgreementHeaderId": 300100651109637,
"lines": [
{
"AgreementLineId": 300100651109639,
"priceBreaks": [
{
"PriceBreakId": 300100651109640,
"PriceBreakNumber": 1,
"DiscountPercent": 12.5
},
{
"PriceBreakNumber": 2,
"ShipToOrganization": "Vision Operations",
"DiscountPercent": 10
}
]
}
]
}
Example 9 Response Body
{
"items": [
{
"PriceBreakId": 300100651109640,
"PriceBreakNumber": 1,
"AgreementLineId": 300100651109639,
"ShipToOrganizationId": 204,
"ShipToOrganizationCode": "V1",
"ShipToOrganization": "Vision Operations",
"LocationId": 300100073052077,
"LocationCode": "New York/ Yonkers City",
"Location": "New York/ Yonkers City",
"Quantity": null,
"UOMCode": "Ea",
"UOM": "Each",
"Price": 6.3,
"DiscountPercent": 10,
"StartDate": null,
"EndDate": null,
"CurrencyCode": "USD",
"Currency": "US Dollar",
"CreatedBy": "CVBUYER01",
"CreationDate": "2026-05-01T07:20:24.808+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2026-05-01T07:20:24.808+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/300100651109640",
"name": "priceBreaks",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109640",
"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/300100651109640/child/DFF",
"name": "DFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks/300100651109640/child/attachments",
"name": "attachments",
"kind": "collection"
}
]
},
{
"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.25,
"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"
}
]
}
],
"count": 2,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/draftPurchaseAgreements/300100651109637/child/lines/300100651109639/child/priceBreaks",
"name": "priceBreaks",
"kind": "collection"
}
]
}