Draft Purchase Agreements
draftPurchaseAgreements Based on 26C
Create, change, delete and look up Draft Purchase Agreements, with business unit access, contract documents and lines. Actions include suggest category and add contract terms.
The record key draftPurchaseAgreementsUniqID is a generated hash. Take it from the record's links (rel self) in a GET response; never build it yourself.
Oracle documents an Effective-Of header and an effectiveDate parameter for this resource, used for date-effective reads and changes.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE16 actions
- Record key
draftPurchaseAgreementsUniqID- Required on create
BuyerIdDocumentStyleIdDocumentTypeCodeProcurementBUId- At a glance
- 129 fields0 finders17 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements?fields=AcknowledgmentDueDate,AcknowledgmentWithinDays,AgingOnsetPoint,AgingOnsetPointCode,AgingPeriodDays&limit=25&onlyData=true
{
"items": [
{
"AcknowledgmentDueDate": "2026-01-31",
"AcknowledgmentWithinDays": 0,
"AgingOnsetPoint": "<string, max 80>",
"AgingOnsetPointCode": "<string, max 30>",
"AgingPeriodDays": 0
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 129
| Attribute | Type | Use |
|---|---|---|
AcknowledgmentDueDate | date | Read-onlySearchable |
AcknowledgmentWithinDays | number | Optional on createUpdatable |
AgingOnsetPoint | text · max 80 | Optional on createUpdatableSearchable |
AgingOnsetPointCode | text · max 30 | Optional on createUpdatableSearchable |
AgingPeriodDays | number | Optional on createUpdatableSearchable |
AgreementAmount | number | Optional on createUpdatableSearchable |
AgreementHeaderId | number | Read-onlySearchable |
AgreementNumber | text · max 30 | Optional on createUpdatableSearchable |
AllowUnassignedSitesFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AmountLimit | number | Optional on createUpdatableSearchable |
AutoSourcingFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AutomaticallyGenerateOrdersFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
AutomaticallySubmitForApprovalFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
BillingCycleClosingDate | date | Optional on createUpdatableSearchable |
Buyer | text · max 240 | Optional on createUpdatableSearchable |
BuyerEmail | text · max 240 | Optional on createUpdatableSearchable |
BuyerFullName | text · max 240 | Read-only |
BuyerId | number | Required on createUpdatableSearchable |
BuyerManagedTransportFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
CancelDocumentFlag | yes/no · max 1 | Read-only |
Carrier | text · max 360 | Optional on createUpdatable |
CarrierId | number | Optional on createUpdatable |
ChangeOrderCreationDate | date-time | Read-onlySearchable |
ChangeOrderDescription | text · max 255 | Optional on createUpdatable |
ChangeOrderInitiatingParty | text · max 255 | Optional on createUpdatable |
ChangeOrderInitiatorId | number | Read-onlySearchable |
ChangeOrderInitiatorRole | text · max 255 | Read-onlySearchable |
ChangeOrderNumber | text · max 80 | Read-onlySearchable |
ChangeOrderSequence | number | Read-onlySearchable |
ChangeOrderStatus | text · max 255 | Read-onlySearchable |
ChangeOrderStatusCode | text · max 25 | Read-onlySearchable |
ChangeOrderType | text · max 255 | Read-onlySearchable |
ChangeOrderTypeCode | text · max 1 | Read-onlySearchable |
ChangeRequestedBy | text · max 360 | Read-only |
Checklist | text · max 80 | Optional on createUpdatableSearchable |
ChecklistId | number | Optional on createUpdatable |
ChecklistNumber | text · max 30 | Optional on createUpdatableSearchable |
CommunicateRepricedOrdersFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ConfiguredItemFlag | yes/no · max 1 | Read-only |
ConfirmingOrderFlag | yes/no · max 1 | Optional on createUpdatable |
ConsignedItemsFlag | yes/no · max 1 | Read-only |
ConsumptionAdviceFrequency | text · max 80 | Optional on createUpdatableSearchable |
ConsumptionAdviceFrequencyCode | text · max 30 | Optional on createUpdatableSearchable |
ConsumptionAdviceSummary | text · max 80 | Optional on createUpdatableSearchable |
ConsumptionAdviceSummaryCode | text · max 30 | Optional on createUpdatableSearchable |
ContractTermsExists | text · max 1 | Optional on createUpdatableSearchable |
CreatedBy | text · max 64 | Read-only |
CreationDate | date-time | Read-onlySearchable |
Currency | text · max 80 | Optional on createUpdatableSearchable |
CurrencyCode | text · max 15 | Optional on createUpdatableSearchable |
DefaultConsignmentLineFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
Description | text · max 240 | Optional on createUpdatableSearchable |
DocumentCreationMethod | text · max 30 | Optional on createUpdatable |
DocumentStyle | text · max 240 | Optional on createUpdatableSearchable |
DocumentStyleId | number | Required on createUpdatableSearchable |
DocumentType | text · max 80 | Optional on createUpdatableSearchable |
DocumentTypeCode | text · max 25 | Required on createUpdatableSearchable |
EnableRetroactivePricingFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
EndDate | date | Optional on createUpdatableSearchable |
EntityChangeTypeCode | text · max 1 | Read-onlySearchable |
FOB | text · max 80 | Optional on createUpdatableSearchable |
FOBCode | text · max 30 | Optional on createUpdatableSearchable |
FreightTerms | text · max 80 | Optional on createUpdatableSearchable |
FreightTermsCode | text · max 30 | Optional on createUpdatableSearchable |
GroupRequisitionLinesFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
GroupRequisitionsFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
IdentificationKey | text · max 255 | Read-onlySearchable |
InitiateRetroactivePricingUponApprovalFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
LastUpdateDate | date-time | Read-only |
LastUpdatedBy | text · max 64 | Read-only |
LatestIdentificationKey | text · max 255 | Read-onlySearchable |
MasterContractId | number | Optional on createUpdatableSearchable |
MasterContractNumber | text · max 120 | Optional on createUpdatableSearchable |
MasterContractType | text | Optional on createUpdatableSearchable |
MasterContractTypeId | number | Optional on createUpdatableSearchable |
MinimumReleaseAmount | number | Optional on createUpdatableSearchable |
ModeOfTransport | text · max 80 | Optional on createUpdatable |
ModeOfTransportCode | text · max 30 | Optional on createUpdatable |
Negotiation | text · max 255 | Read-onlySearchable |
NegotiationId | number | Read-onlySearchable |
NoteToAuthorizer | text · max 1000 | Optional on createUpdatableSearchable |
NoteToReceiver | text · max 1000 | Optional on createUpdatable |
NoteToSupplier | text · max 1000 | Optional on createUpdatable |
OkcContractId | number | Read-onlySearchable |
OkcContractNumber | text · max 255 | Read-onlySearchable |
OutsideProcessingFlag | yes/no · max 1 | Read-only |
PayOnReceiptFlag | yes/no · max 25 | Optional on createUpdatable |
PayOnUseFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
PaymentTerms | text · max 50 | Optional on createUpdatableSearchable |
PaymentTermsId | number | Optional on createUpdatableSearchable |
PriceBreaksFlag | yes/no · max 1 | Read-only |
PriceUpdateTolerance | number | Optional on createUpdatable |
Priority | number | Optional on createUpdatableSearchable |
ProcurementBU | text · max 240 | Optional on createUpdatableSearchable |
ProcurementBUId | number | Required on createUpdatableSearchable |
PunchoutRequestsOnlyFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ReferenceNumber | text · max 120 | Optional on createUpdatableSearchable |
ReleasedAmount | number | Read-onlySearchable |
RepriceOpenOrdersFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
RequiredAcknowledgment | text · max 80 | Optional on createUpdatable |
RequiredAcknowledgmentCode | text · max 1 | Optional on createUpdatable |
RequiresSignatureFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
ScheduleGroup | text · max 30 | Optional on createUpdatableSearchable |
ScheduleGroupMeaning | text · max 80 | Optional on createUpdatableSearchable |
ServiceLevel | text · max 80 | Optional on createUpdatable |
ServiceLevelCode | text · max 30 | Optional on createUpdatable |
ShippingMethod | text | Optional on createUpdatableSearchable |
StartDate | date | Optional on createUpdatableSearchable |
Status | text · max 80 | Read-onlySearchable |
StatusCode | text · max 40 | Read-onlySearchable |
Supplier | text · max 360 | Optional on createUpdatableSearchable |
SupplierAgreement | text · max 25 | Optional on createUpdatable |
SupplierCommunicationMethodCode | text · max 25 | Optional on createUpdatable |
SupplierContact | text · max 4000 | Optional on createUpdatable |
SupplierContactFullName | text | Read-only |
SupplierContactId | number | Optional on createUpdatable |
SupplierEmailAddress | text · max 2000 | Optional on createUpdatable |
SupplierFax | text · max 60 | Optional on createUpdatable |
SupplierId | number | Optional on createUpdatableSearchable |
SupplierPartyId | number | Optional on createUpdatableSearchable |
SupplierPayOnUseFlag | yes/no · max 1 | Read-only |
SupplierSite | text · max 240 | Optional on createUpdatableSearchable |
SupplierSiteId | number | Optional on createUpdatableSearchable |
UseCustomerSalesOrderFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
UseOrderDateForOrderPricingFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
UseRequestedDateFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
UseShipToLocationFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
UseShipToOrganizationAndLocationFlag | yes/no · max 1 | Optional on createUpdatableSearchable |
VersionId | number | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 17
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/<name>. Add them to a GET with expand.
DFFGET · POST · PATCH Descriptive Flexfields · 3 fieldsPoHeaderId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebusinessUnitAccessGET · POST · PATCH · DELETE Business Unit Accesses · 20 fieldsBillToBUBillToLocationBillToLocationIdBilltoBUIdCreatedByCreationDateEnabledFlagEntityChangeTypeCodeIsOrderLocallyReadOnlyFlagLastUpdateDateLastUpdatedByOrderLocallyFlagOrganizationAssignmentIdPurchasingSitePurchasingSiteIdRequisitioningBURequisitioningBUIdShipToLocationShipToLocationCodeShipToLocationIdcontractDocumentsGET · POST · PATCH · DELETE Contract Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamelinesGET · POST · PATCH · DELETE Purchase Agreement Lines · 78 fieldsAcknowledgeResponseCodeAgingPeriodDaysAgreementAmountAgreementHeaderIdAgreementLineIdAgreementQuantityAllowItemDescriptionUpdateFlagAllowPriceOverrideFlagAmountAmountReleasedCancelFlagCancelReasonCancelledByCategoryCategoryCodeCategoryIdComponentAmountReleasedComponentQuantityReleasedConsignmentLineFlagCreatedByCreationDateCurrencyCurrencyCodeDeliveredAmountDeliveredQuantityDescriptionEntityChangeTypeCodeExpirationDateHazardClassHazardClassCodeHazardClassIdInvoicedAmountInvoicedQuantityIsLineApprovedOnceFlagItemItemAllowItemDescriptionUpdateFlagItemIdItemRevisionLastUpdateDateLastUpdatedByLineNumberLineStartDateLineTypeLineTypeIdMinimumReleaseAmountNegotiatedFlagNegotiationNoteToSupplierParentItemParentItemIdPimItemCategoryPimItemCategoryCodePimItemCategoryIdPimItemDescriptionPricePriceBreakTypePriceBreakTypeCodePriceLimitPurchaseBasisPurchaseOrdersCreatedReasonForChangeReceivedAmountReceivedQuantityRejectedReasonReleasedQuantityStatusStatusCodeSupplierItemSupplierParentItemSupplierPartAuxidSupplierTopModelTopModelTopModelIdUNNumberUNNumberDescriptionUNNumberIdUOMUOMCodeDFFGET · POST · PATCH Descriptive Flexfields · 3 fieldsPoLineId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameitemAttributesGET · POST · PATCH Item Attributes · 30 fields · 1 findersAgreementLineIdAliasAttachmentURLAttributeValuesIdAttributeValuesTlpIdAvailabilityCommentsCreatedByCreationDateEntityChangeTypeCodeHazardClassHazardClassCodeHazardClassIdImageURLLastUpdateDateLastUpdatedByLeadTimeDaysLongDescriptionManufacturerManufacturerPartNumberManufacturerURLPackagingStringRoundingFactorSupplierPartAuxidSupplierURLThumbnailImageURLUNNumberUNNumberDescriptionUNNumberIdUNSPSCDFFGET · POST · PATCH Descriptive Flexfields · 3 fieldsAttributeValuesId__FLEX_Context__FLEX_Context_DisplayValuepriceBreaksGET · POST · PATCH · DELETE Price Breaks · 27 fieldsAgreementLineIdCancelFlagCreatedByCreationDateCurrencyCurrencyCodeDiscountPercentEndDateEntityChangeTypeCodeLastUpdateDateLastUpdatedByLocationLocationCodeLocationIdNumberOfPriceBreakAttachmentsNumberOfPriceBreakSupplierAttachmentsPricePriceBreakIdPriceBreakNumberQuantityReasonForChangeShipToOrganizationShipToOrganizationCodeShipToOrganizationIdStartDateUOMUOMCodeDFFGET · POST · PATCH Descriptive Flexfields · 3 fieldsLineLocationId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamenotificationControlsGET · POST · PATCH · DELETE Notification Controls · 13 fieldsAmountConditionConditionCodeCreatedByCreationDateEndDateEntityChangeTypeCodeLastUpdateDateLastUpdatedByNotificationIdPercentageReminderDaysStartDateDFFGET · POST · PATCH Descriptive Flexfields · 3 fieldsNotificationId__FLEX_Context__FLEX_Context_DisplayValuesupportingDocumentsGET · POST · PATCH · DELETE Supporting Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNametemplateUsagesGET Template Usages · 15 fieldsAuthoringPartyAuthoringPartyCodeContractExpertEnabledContractSourceCodeCreatedByCreationDateDescriptionDocumentNumberLastUpdateDateLastUpdatedBySimpleContractTextSimpleContractYnSourceCodeTemplateIdTemplateNameContractFormAttachmentGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Actions 16
POST …/action/suggestCategory·itemDescriptionsPOST …/{draftPurchaseAgreementsUniqID}/action/addContractTerms·authoringPartyCodefileNamecontractSourceCodedescriptiontemplateIdaccessModetitlefileContentTypefileInStreamPOST …/{draftPurchaseAgreementsUniqID}/action/applyLatestTemplate·authoringPartyCodecontractSourceCodeaccessModePOST …/{draftPurchaseAgreementsUniqID}/action/cancelChangeOrder·cancellationReasoninitiatingPartyPOST …/{draftPurchaseAgreementsUniqID}/action/changeContractSource·authoringPartyCodefileNametemplateNamecontractSourceCodedescriptiontemplateIdaccessModetitlefileContentTypefileInStreamPOST …/{draftPurchaseAgreementsUniqID}/action/deleteChangeOrder·initiatingPartyPOST …/{draftPurchaseAgreementsUniqID}/action/downloadLinesResourcesPOST …/{draftPurchaseAgreementsUniqID}/action/eSign·esignEnvelopeIdeSignActionesignEnvOwnerEmailIdPOST …/{draftPurchaseAgreementsUniqID}/action/removeContractTermsPOST …/{draftPurchaseAgreementsUniqID}/action/submit·validateBeforeSubmitFlagbypassApprovalsFlagPOST …/{draftPurchaseAgreementsUniqID}/action/transferAuthoring·toRolefromRolePOST …/{draftPurchaseAgreementsUniqID}/action/validateDocumentPOST …/{draftPurchaseAgreementsUniqID}/action/viewMasterContractPOST …/{draftPurchaseAgreementsUniqID}/action/viewPDFPOST …/{draftPurchaseAgreementsUniqID}/action/withdraw·withdrawReasoninitiatingPartyPOST …/{draftPurchaseAgreementsUniqID}/child/lines/{AgreementLineId}/action/undoChanges
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreementsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:AcknowledgmentWithinDays, notacknowledgmentwithindays. - 35 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
onlyData=trueremoveslinks, and this resource's key only comes fromlinks. Leave it off when you need the key.- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.