Purchase Agreements
purchaseAgreements Based on 26C
Look up Purchase Agreements, with business unit access, contract documents and lifecycle details. Actions include cancel and cancel change order. Changes only through its actions.
The record key purchaseAgreementsUniqID 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)15 actions
- Record key
purchaseAgreementsUniqID- Required on create
- no create on this resource
- At a glance
- 119 fields1 finders19 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/purchaseAgreements?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 119
| Attribute | Type | Use |
|---|---|---|
AcknowledgmentDueDate | date | Read-onlySearchable |
AcknowledgmentWithinDays | number | Read-onlySearchable |
AgingOnsetPoint | text · max 80 | Read-onlySearchable |
AgingOnsetPointCode | text · max 30 | Read-onlySearchable |
AgingPeriodDays | number | Read-onlySearchable |
AgreementAmount | number | Read-onlySearchable |
AgreementHeaderId | number | Read-onlySearchable |
AgreementNumber | text · max 30 | Read-onlySearchable |
AllowUnassignedSitesFlag | yes/no · max 1 | Read-onlySearchable |
AmountLimit | number | Read-onlySearchable |
AutoSourcingFlag | yes/no · max 1 | Read-only |
AutomaticallyGenerateOrdersFlag | yes/no · max 1 | Read-onlySearchable |
AutomaticallySubmitForApprovalFlag | yes/no · max 1 | Read-onlySearchable |
BillingCycleClosingDate | date | Read-only |
Buyer | text · max 240 | Read-onlySearchable |
BuyerFullName | text · max 240 | Read-only |
BuyerId | number | Read-onlySearchable |
BuyerManagedTransportFlag | yes/no · max 1 | Read-onlySearchable |
Carrier | text · max 360 | Read-onlySearchable |
CarrierId | number | Read-onlySearchable |
CatAdministratorAuthEnabledFlag | yes/no · max 1 | Read-onlySearchable |
Checklist | text · max 80 | Read-onlySearchable |
ChecklistId | number | Read-only |
ClosedDate | date | Read-onlySearchable |
CommunicateRepricedOrdersFlag | yes/no · max 1 | Read-onlySearchable |
ConfigurationOrderingEnabledFlag | yes/no · max 1 | Read-only |
ConfirmingOrderFlag | yes/no · max 1 | Read-onlySearchable |
ConsignmentTermsFlag | yes/no · max 1 | Read-only |
ConsumptionAdviceFrequency | text · max 80 | Read-onlySearchable |
ConsumptionAdviceFrequencyCode | text · max 30 | Read-onlySearchable |
ConsumptionAdviceSummary | text · max 80 | Read-onlySearchable |
ConsumptionAdviceSummaryCode | text · max 30 | Read-onlySearchable |
ConversionRate | number | Read-onlySearchable |
ConversionRateDate | date | Read-onlySearchable |
ConversionRateTypeCode | text · max 30 | Read-onlySearchable |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
Currency | text · max 80 | Read-onlySearchable |
CurrencyCode | text · max 15 | Read-onlySearchable |
DefaultConsignmentLinesFlag | yes/no · max 1 | Read-only |
Description | text · max 240 | Read-onlySearchable |
DocumentStyle | text · max 240 | Read-onlySearchable |
DocumentStyleAllowedForGoodsFlag | yes/no | Read-only |
DocumentStyleId | number | Read-onlySearchable |
DocumentTypeCode | text · max 25 | Read-onlySearchable |
EnableRetroactivePricingFlag | yes/no · max 1 | Read-onlySearchable |
EndDate | date | Read-onlySearchable |
FOB | text · max 80 | Read-onlySearchable |
FOBCode | text · max 30 | Read-onlySearchable |
FreightTerms | text · max 80 | Read-onlySearchable |
FreightTermsCode | text · max 30 | Read-onlySearchable |
FrozenFlag | yes/no · max 1 | Read-only |
GroupRequisitionLinesFlag | yes/no · max 1 | Read-onlySearchable |
GroupRequisitionsFlag | yes/no · max 1 | Read-onlySearchable |
HasAttachmentsFlag | yes/no · max 255 | Read-onlySearchable |
InitiateRetroactivePricingUponApprovalFlag | yes/no · max 1 | Read-onlySearchable |
LastBilledDate | date | Read-only |
LastUpdateDate | date-time | Read-onlySearchable |
LastUpdatedBy | text · max 64 | Read-onlySearchable |
MasterContractId | number | Read-onlySearchable |
MasterContractNumber | text · max 120 | Read-onlySearchable |
MasterContractType | text · max 255 | Read-onlySearchable |
MasterContractTypeId | number | Read-onlySearchable |
MinimumReleaseAmount | number | Read-onlySearchable |
ModeOfTransport | text · max 80 | Read-onlySearchable |
ModeOfTransportCode | text · max 30 | Read-onlySearchable |
Negotiation | text · max 255 | Read-only |
NegotiationId | number | Read-only |
NoteToAuthorizer | text · max 1000 | Read-onlySearchable |
NoteToReceiver | text · max 1000 | Read-onlySearchable |
NoteToSupplier | text · max 1000 | Read-onlySearchable |
OkcContractId | number | Read-onlySearchable |
OkcContractNumber | text · max 255 | Read-onlySearchable |
PayOnReceiptFlag | yes/no · max 25 | Read-onlySearchable |
PayOnUseFlag | yes/no · max 1 | Read-only |
PaymentTerms | text · max 50 | Read-onlySearchable |
PaymentTermsId | number | Read-onlySearchable |
PendingResponseRole | text · max 25 | Read-only |
PriceBreaksFlag | yes/no · max 1 | Read-onlySearchable |
PriceUpdateTolerance | number | Read-only |
Priority | number | Read-onlySearchable |
ProcurementBU | text · max 240 | Read-onlySearchable |
ProcurementBUId | number | Read-onlySearchable |
ProgressPaymentFlag | yes/no · max 1 | Read-only |
PunchoutRequestsOnlyFlag | yes/no · max 1 | Read-onlySearchable |
ReferenceNumber | text · max 120 | Read-onlySearchable |
ReleasedAmount | number | Read-onlySearchable |
RepriceOpenOrdersFlag | yes/no · max 1 | Read-onlySearchable |
RequiredAcknowledgment | text · max 80 | Read-onlySearchable |
RequiredAcknowledgmentCode | text · max 1 | Read-onlySearchable |
RequiresSignatureFlag | yes/no · max 1 | Read-onlySearchable |
RequisitioningBUId | number | Read-onlySearchable |
RevisionNumber | number | Read-onlySearchable |
ScheduleGroup | text · max 80 | Read-onlySearchable |
ServiceLevel | text · max 80 | Read-onlySearchable |
ServiceLevelCode | text · max 30 | Read-onlySearchable |
SoldToLegalEntityId | number | Read-onlySearchable |
StartDate | date | Read-onlySearchable |
Status | text · max 80 | Read-onlySearchable |
StatusCode | text · max 25 | Read-onlySearchable |
Supplier | text · max 360 | Read-onlySearchable |
SupplierAgreement | text · max 25 | Read-onlySearchable |
SupplierCommunicationMethod | text · max 80 | Read-only |
SupplierCommunicationMethodCode | text · max 25 | Read-onlySearchable |
SupplierContact | text · max 4000 | Read-onlySearchable |
SupplierContactDisplayName | text · max 360 | Read-only |
SupplierContactId | number | Read-onlySearchable |
SupplierEmailAddress | text · max 2000 | Read-onlySearchable |
SupplierFax | text · max 60 | Read-onlySearchable |
SupplierId | number | Read-onlySearchable |
SupplierPartyId | number | Read-only |
SupplierSite | text · max 240 | Read-onlySearchable |
SupplierSiteId | number | Read-onlySearchable |
UploadLinesJobStatusCode | text · max 240 | Read-only |
UseCustomerSalesOrderFlag | yes/no · max 1 | Read-onlySearchable |
UseOrderDateForOrderPricingFlag | yes/no · max 1 | Read-onlySearchable |
UseRequestedDateFlag | yes/no · max 1 | Read-onlySearchable |
UseShipToLocationFlag | yes/no · max 1 | Read-onlySearchable |
UseShipToOrganizationAndLocationFlag | yes/no · max 1 | Read-onlySearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByIntent·AgreementHeaderIdEntityTypeEntityTypeIdIntentSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 19
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/purchaseAgreements/{purchaseAgreementsUniqID}/child/<name>. Add them to a GET with expand.
DFFGET Descriptive Flexfields for Purchasing Documents · 3 fieldsPoHeaderId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamebusinessUnitAccessGET Business Unit Accesses · 18 fieldsBillToBUBillToLocationBillToLocationIdBilltoBUIdCreatedByCreationDateEnabledFlagLastUpdateDateLastUpdatedByOrderLocallyFlagOrganizationAssignmentIdPurchasingSitePurchasingSiteIdRequisitioningBURequisitioningBUIdShipToLocationShipToLocationCodeShipToLocationIdcontractDocumentsGET Contract Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamelifecycleDetailsGET Purchase Agreement Lifecycle Details · 9 fieldsAgreedAmountAgreementHeaderIdAgreementNumberCurrencyCodeDeliveredAmountInvoicedAmountOrderedAmountPurchaseOrdersCreatedReceivedAmountlinesGET Purchase Agreement Lines · 65 fields · 2 findersAgingPeriodDaysAgreementAmountAgreementHeaderIdAgreementLineIdAgreementNumberAgreementQuantityAllowItemDescriptionUpdateFlagAllowPriceOverrideFlagAmountCategoryCategoryCodeCategoryIdConsignmentLineFlagCreatedByCreationDateCurrencyCurrencyCodeDescriptionExpirationDateHazardClassHazardClassCodeHazardClassIdItemItemIdItemRevisionLastUpdateDateLastUpdatedByLineNumberLineStartDateLineTypeLineTypeIdMinimumReleaseAmountNegotiatedFlagNoteToSupplierParentItemParentItemIdPimItemCategoryPimItemCategoryCodePimItemCategoryIdPimItemDescriptionPricePriceBreakTypePriceBreakTypeCodePriceLimitProcurementBUProcurementBUIdPurchaseBasisReleasedAmountStatusStatusCodeSupplierSupplierIdSupplierItemSupplierItemAuxiliaryIdentifierSupplierParentItemSupplierSiteSupplierSiteIdSupplierTopModelTopModelTopModelIdUNNumberDescriptionUOMUOMCodeUnNumberUnNumberIdDFFGET Descriptive Flexfields · 3 fieldsPoLineId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameitemAttributesGET Item Attributes · 28 fieldsAliasAttachmentURLAttributeValuesIdAttributeValuesTlpIdAvailabilityCommentsCreatedByCreationDateHazardClassHazardClassCodeHazardClassIdImageURLLastUpdateDateLastUpdatedByLeadTimeDaysLongDescriptionManufacturerManufacturerPartNumberManufacturerURLPackagingStringRoundingFactorSupplierPartAuxidSupplierURLThumbnailImageURLUNNumberUNNumberDescriptionUNNumberIdUNSPSCDFFGET Agreement Line Item DFF · 3 fieldsAttributeValuesId__FLEX_Context__FLEX_Context_DisplayValuelifecycleDetailsGET Purchase Agreement Line Lifecycle Details · 15 fieldsAgreementAmountAgreementHeaderIdAgreementLineIdAgreementQuantityAmountReleasedComponentAmountReleasedComponentQuantityReleasedDeliveredAmountDeliveredQuantityInvoicedAmountInvoicedQuantityPurchaseOrdersCreatedReceivedAmountReceivedQuantityReleasedQuantitypriceBreaksGET Price Breaks · 22 fieldsCreatedByCreationDateCurrencyCurrencyCodeDiscountPercentEndDateLastUpdateDateLastUpdatedByLineNumberLocationLocationCodeLocationIdPricePriceBreakIdPriceBreakNumberQuantityShipToOrganizationShipToOrganizationCodeShipToOrganizationIdStartDateUOMUOMCodeDFFGET Descriptive Flexfields · 3 fieldsLineLocationId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamenotificationControlsGET Notification Controls · 12 fieldsAmountConditionConditionCodeCreatedByCreationDateEndDateLastUpdateDateLastUpdatedByNotificationIdPercentageReminderDaysStartDateDFFGET Descriptive Flexfields · 3 fieldsNotificationId__FLEX_Context__FLEX_Context_DisplayValuesupportingDocumentsGET Supporting Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNametemplateUsagesGET Template Usages · 15 fieldsAuthoringPartyAuthoringPartyCodeContractExpertEnabledContractSourceCodeCreatedByCreationDateDescriptionDocumentNumberLastUpdateDateLastUpdatedBySimpleContractTextSimpleContractYnSourceCodeTemplateIdTemplateNameContractFormAttachmentGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Actions 15
POST …/{purchaseAgreementsUniqID}/action/cancel·acknowledgeWithinDayscommunicationMethodcancellationReasonrequiredAcknowledgmentinitiatingPartyfaxemailPOST …/{purchaseAgreementsUniqID}/action/cancelChangeOrder·cancellationReasoninitiatingPartyPOST …/{purchaseAgreementsUniqID}/action/communicatePurchaseAgreement·preferredLanguagecommunicationMethodfaxemailPOST …/{purchaseAgreementsUniqID}/action/createProposal·initiatingPartyPOST …/{purchaseAgreementsUniqID}/action/duplicate·copyAttachmentscopyContractTermsPOST …/{purchaseAgreementsUniqID}/action/finallyClose·finallyCloseReasonPOST …/{purchaseAgreementsUniqID}/action/freeze·freezeReasonPOST …/{purchaseAgreementsUniqID}/action/generateHighlightsPOST …/{purchaseAgreementsUniqID}/action/hold·holdReasonPOST …/{purchaseAgreementsUniqID}/action/manageCatalogAdminAuthoring·actionPOST …/{purchaseAgreementsUniqID}/action/removeHold·removeHoldReasonPOST …/{purchaseAgreementsUniqID}/action/renegotiate·parametersPOST …/{purchaseAgreementsUniqID}/action/unfreeze·unfreezeReasonPOST …/{purchaseAgreementsUniqID}/action/viewMasterContractPOST …/{purchaseAgreementsUniqID}/action/viewPDF
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/purchaseAgreementsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByIntentfor the agent's main search: its variables become clean tool parameters. - 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:AcknowledgmentDueDate, notacknowledgmentduedate. 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.