Purchase Orders
purchaseOrders Based on 26C
Look up Purchase Orders, with contract documents, lines and supporting documents. Actions include acknowledge and cancel. Changes only through its actions.
The record key purchaseOrdersUniqID 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)21 actions
- Record key
purchaseOrdersUniqID- Required on create
- no create on this resource
- At a glance
- 130 fields1 finders21 children
- Extra parameters
?effectiveDate=Effective-Of:
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/purchaseOrders?fields=AcknowledgeWithinDays,AcknowledgmentDueDate,AdditionalContactEmail,BillToBU,BillToBUId&limit=25&onlyData=true
{
"items": [
{
"AcknowledgeWithinDays": 0,
"AcknowledgmentDueDate": "2026-01-31",
"AdditionalContactEmail": "<string, max 2000>",
"BillToBU": "<string, max 240>",
"BillToBUId": 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 130
| Attribute | Type | Use |
|---|---|---|
AcknowledgeWithinDays | number | Read-only |
AcknowledgmentDueDate | date | Read-onlySearchable |
AdditionalContactEmail | text · max 2000 | Read-only |
BillToBU | text · max 240 | Read-onlySearchable |
BillToBUId | number | Read-onlySearchable |
BillToLocation | text | Searchable |
BillToLocationAddress | text · max 255 | Read-onlySearchable |
BillToLocationId | number | Read-onlySearchable |
BudgetControlEnabledFlag | yes/no · max 1 | Read-only |
Buyer | text · max 240 | Read-onlySearchable |
BuyerDisplayName | text · max 240 | Read-onlySearchable |
BuyerId | number | Read-onlySearchable |
BuyerManagedTransportFlag | yes/no · max 1 | Read-onlySearchable |
Carrier | text · max 360 | Read-only |
CarrierId | number | Read-only |
Checklist | text · max 80 | Read-only |
ChecklistId | number | Read-only |
ConfigurationOrderingEnabledFlag | yes/no · max 1 | Read-onlySearchable |
ConfirmingOrderFlag | yes/no · max 1 | Read-only |
ConsignmentTermsFlag | yes/no · max 1 | Read-only |
ConversionRate | number | Read-only |
ConversionRateDate | date | Read-only |
ConversionRateType | text · max 30 | Read-only |
CreatedBy | text · max 64 | Read-onlySearchable |
CreationDate | date-time | Read-onlySearchable |
CreditAmount | number | Read-only |
Currency | text · max 80 | Read-onlySearchable |
CurrencyCode | text · max 15 | Read-onlySearchable |
CurrentVersionId | number | Read-only |
DefaultTaxationCountry | text · max 80 | Read-only |
DefaultTaxationCountryCode | text · max 2 | Read-only |
Description | text · max 240 | Read-onlySearchable |
DiscountAmount | number | Read-only |
DocumentFiscalClassification | text · max 1996 | Read-only |
DocumentFiscalClassificationCode | text · max 240 | Read-only |
DocumentFiscalClassificationId | number | Read-only |
DocumentStyle | text · max 240 | Read-onlySearchable |
DocumentStyleId | number | Read-onlySearchable |
FOB | text · max 80 | Read-only |
FOBCode | text · max 30 | Read-only |
FirstPartyRegistrationId | number | Read-only |
FirstPartyRegistrationNumber | text · max 50 | Read-only |
FreightTerms | text · max 80 | Read-only |
FreightTermsCode | text · max 30 | Read-only |
FrozenFlag | yes/no · max 1 | Read-only |
FundsStatus | text · max 80 | Read-onlySearchable |
FundsStatusCode | text · max 25 | Read-only |
ImportSourceCode | text · max 25 | 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 | |
MasterContractTypeId | number | |
ModeOfTransport | text · max 80 | Read-only |
ModeOfTransportCode | text · max 30 | Read-only |
Negotiation | text · max 255 | Read-only |
NegotiationSupplierSiteId | number | Read-onlySearchable |
NonRecoverableInclusiveTax | number | Read-onlySearchable |
NonRecoverableTax | number | Read-onlySearchable |
NoteToReceiver | text · max 1000 | Read-only |
NoteToSupplier | text · max 1000 | Read-only |
OkcContractId | number | Read-onlySearchable |
OkcContractNumber | text · max 255 | Read-onlySearchable |
OrderDate | date-time | Read-only |
OrderNumber | text · max 30 | Read-onlySearchable |
Ordered | number | Read-only |
OrderedAmountBeforeAdjustments | number | Read-only |
OverrideB2BCommunicationFlag | yes/no · max 1 | Read-onlySearchable |
OverridingApprover | text · max 240 | Read-onlySearchable |
OverridingApproverDisplayName | text · max 240 | Read-only |
OverridingApproverId | number | Read-onlySearchable |
POHeaderId | number | Read-onlySearchable |
PayOnReceiptFlag | yes/no · max 25 | Read-only |
PaymentTerms | text · max 50 | Read-only |
PaymentTermsId | number | Read-only |
PendingResponseRole | text · max 25 | Read-onlySearchable |
ProcurementBU | text · max 240 | Read-onlySearchable |
ProcurementBUId | number | Read-onlySearchable |
ProgressPaymentFlag | yes/no · max 1 | Read-onlySearchable |
PurchaseBasis | text | Read-only |
RecoverableInclusiveTax | number | Read-onlySearchable |
RecoverableTax | number | Read-onlySearchable |
ReferenceNumber | text · max 120 | Read-only |
RequesterDisplayName | text | Read-only |
RequesterId | number | Read-only |
RequiredAcknowledgment | text · max 80 | Read-only |
RequiredAcknowledgmentCode | text · max 1 | Read-only |
RequiresSignatureFlag | yes/no · max 1 | Read-onlySearchable |
Requisition | text · max 255 | Read-only |
RequisitionHeaderId | number | Read-onlySearchable |
RequisitioningBU | text · max 240 | Read-onlySearchable |
RequisitioningBUId | number | Read-onlySearchable |
RetainageFlag | yes/no · max 1 | Read-onlySearchable |
Revision | number | Read-only |
SalesOrder | text · max 255 | Read-only |
ServiceLevel | text · max 80 | Read-only |
ServiceLevelCode | text · max 30 | Read-only |
ShipToLocationAddress | text | Read-only |
ShipToLocationCode | text | Read-only |
ShipToLocationId | number | Read-only |
ShippingMethod | text · max 255 | Read-only |
SoldToLegalEntity | text · max 240 | Read-onlySearchable |
SoldToLegalEntityId | number | Read-onlySearchable |
SourceAgreement | text · max 255 | Read-only |
SourceAgreementId | number | Read-onlySearchable |
SpecialHandlingType | text · max 30 | Read-onlySearchable |
SpecialHandlingTypeCode | text · max 30 | Read-onlySearchable |
Status | text · max 80 | Read-onlySearchable |
StatusCode | text · max 25 | Read-onlySearchable |
Supplier | text · max 360 | Read-onlySearchable |
SupplierBccEmailAddress | text · max 2000 | Read-onlySearchable |
SupplierCcEmailAddress | text · max 2000 | Read-onlySearchable |
SupplierCommunicationMethod | text · max 80 | Read-onlySearchable |
SupplierCommunicationMethodCode | text · max 25 | Read-onlySearchable |
SupplierContact | text · max 360 | Read-only |
SupplierContactDisplayName | text · max 360 | Read-only |
SupplierContactId | number | Read-only |
SupplierEmailAddress | text · max 2000 | Read-onlySearchable |
SupplierFax | text · max 60 | Read-onlySearchable |
SupplierId | number | Read-onlySearchable |
SupplierOrder | text · max 25 | Read-only |
SupplierPartyId | number | Read-onlySearchable |
SupplierSite | text · max 240 | Read-onlySearchable |
SupplierSiteId | number | Read-onlySearchable |
ThirdPartyRegistrationId | number | Read-only |
ThirdPartyRegistrationNumber | text · max 50 | Read-only |
Total | number | Read-only |
TotalTax | number | Read-only |
WcEnabledFlag | 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·IntentPOHeaderIdSysEffectiveDate
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 21
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/<name>. Add them to a GET with expand.
DFFGET Descriptive Flexfields for Purchasing Documents · 3 fieldsPoHeaderId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecontractDocumentsGET Contract Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameglobalDFFsGET US Federal Attributes for Purchase OrdersFields depend on your pod's flexfield setup (check
/describe).linesGET Lines · 77 fieldsBaseModelBaseModelIdBaseModelPriceBasePriceBidLineNumberBidNumberCategoryCategoryCodeCategoryIdConfiguredItemFlagConsignmentLineFlagCreatedByCreationDateCreditFlagCurrencyCurrencyCodeDescriptionDiscountDiscountReasonDiscountTypeFundsStatusCodeHazardClassHazardClassCodeHazardClassIdItemItemIdItemRevisionLastUpdateDateLastUpdatedByLineNumberLineTypeLineTypeIdManufacturerManufacturerPartNumberMaximumRetainageAmountNegotiatedFlagNegotiationNegotiationIdNegotiationLineNonRecoverableInclusiveTaxNonRecoverableTaxNoteToSupplierOptionsPriceOrderNumberOrderedPOHeaderIdPOLineIdPricePricingUOMPricingUOMCodeQuantityRecoverableInclusiveTaxRecoverableTaxSecondaryQuantitySecondaryUOMSecondaryUOMCodeSourceAgreementIdSourceAgreementLineSourceAgreementLineIdSourceAgreementNumberSourceAgreementProcurementBUSourceAgreementProcurementBUIdSourceAgreementTypeSourceAgreementTypeCodeStatusStatusCodeSupplierConfigurationIdSupplierItemTotalTotalTaxUNNumberUNNumberCodeUNNumberDescriptionUNNumberIdUOMUOMCodeWorkOrderProductDFFGET Descriptive Flexfields · 3 fieldsPoLineId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNameconfigurationComponentsGET · POST · PATCH · DELETE Configuration Components · 31 fieldsBaseModelBaseModelIdComponentLineIdComponentLineNumberCurrencyCurrencyCodeDescriptionExtendedPriceExtendedPriceWithQualifierItemItemIdItemTypeItemTypeCodeLineNumberOrderNumberPOHeaderIdPOLineIdParentComponentLineIdParentComponentLineNumberPricePriceWithQualifierQuantityQuantityWithQualifierRevisionSourceAgreementIdSourceAgreementLineSourceAgreementLineIdSourceAgreementNumberSupplierItemUOMUOMCodeschedulesGET Schedules · 136 fieldsAccrueAtReceiptFlagAllowSubstituteReceiptsFlagAssessableValueBackToBackFlagBilledAmountBilledQuantityCarrierCarrierIdCountryOfOriginCountryOfOriginCodeCreatedByCreationDateCurrencyCurrencyCodeCustomerItemCustomerItemDescriptionCustomerPOLineNumberCustomerPONumberCustomerPOScheduleNumberDeliverToLocationDeliverToLocationIdDescriptionDestinationTypeDestinationTypeCodeEarlyReceiptToleranceDaysFirmFlagInvoiceCloseTolerancePercentInvoiceMatchOptionInvoiceMatchOptionCodeKanbanCardNumberLastAcceptDateLastAcceptableDeliveryDateLastAcceptableShipDateLastUpdateDateLastUpdatedByLateReceiptToleranceDaysLineIntendedUseLineIntendedUseIdLineLocationIdLineNumberLocationOfFinalDischargeCodeLocationOfFinalDischargeIdMatchApprovalLevelCodeModeOfTransportModeOfTransportCodeNonRecoverableInclusiveTaxNonRecoverableTaxNoteToReceiverOrchestrationAgreementLineNumberOrchestrationAgreementNumberOrderNumberOrderedOriginalPromisedDeliveryDateOriginalPromisedShipDateOverReceiptActionOverReceiptActionCodeOverReceiptTolerancePercentPOHeaderIdPOLineIdPOTradingOrganizationPOTradingOrganizationCodePOTradingOrganizationIdPricePricingUOMPricingUOMCodePrimaryTradeRelationshipIdProductCategoryProductCategoryCodeProductFiscalClassificationProductFiscalClassificationCodeProductFiscalClassificationIdProductTypeProductTypeCodePromisedDeliveryDatePromisedShipDateQuantityReceiptCloseTolerancePercentReceiptDateExceptionActionReceiptDateExceptionActionCodeReceiptRoutingReceiptRoutingIdReceivedAmountReceivedQuantityRecoverableInclusiveTaxRecoverableTaxRequestedDeliveryDateRequestedShipDateRequesterRequesterIdRequisitionRequisitionHeaderIdRetainageAmountRetainageRateRetainageReleasedAmountSalesOrderLineNumberSalesOrderNumberSalesOrderScheduleNumberScheduleNumberSecondaryQuantitySecondaryUOMSecondaryUOMCodeShipToCustomerShipToCustomerContactShipToCustomerContactIdShipToCustomerIdShipToCustomerLocationShipToCustomerLocationIdShipToExceptionActionShipToExceptionActionCodeShipToLocationCodeShipToLocationIdShipToOrganizationShipToOrganizationCodeShipToOrganizationIdShippingMethodStatusStatusCodeSubinventorySupplierOrderSupplierOrderLineNumberTaxClassificationTaxClassificationCodeTotalTotalTaxTransactionBusinessCategoryTransactionBusinessCategoryCodeTransactionBusinessCategoryIdTypeTypeCodeUOMUOMCodeUserDefinedFiscalClassificationUserDefinedFiscalClassificationCodeWorkOrderIdWorkOrderNumberWorkOrderOperationSequenceDFFGET Descriptive Flexfields · 3 fieldsLineLocationId__FLEX_Context__FLEX_Context_DisplayValueattachmentsGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamedistributionsGET Distributions · 62 fieldsBudgetDateChartOfAccountIdConversionRateConversionRateDateConversionRateTypeCreatedByCreationDateCurrencyCurrencyCodeDeliverToCustomerDeliverToCustomerIdDeliverToCustomerLocationDeliverToCustomerLocationIdDeliverToLocationCodeDeliverToLocationIdDestChartOfAccountIdDestinationChargeAccountDestinationChargeAccountIdDestinationSubinventoryDestinationSubinventoryNameDestinationVarianceAccountDestinationVarianceAccountIdDistributionNumberFundsStatusFundsStatusCodeIsDestinationChargeAccountVisibleFlagLastUpdateDateLastUpdatedByLineNumberNonrecoverableExclusiveTaxNonrecoverableInclusiveTaxOrderNumberOrderedPOAccrualAccountPOAccrualAccountIdPOChargeAccountPOChargeAccountIdPODistributionIdPOHeaderIdPOLineIdPOVarianceAccountPOVarianceAccountIdPercentageQuantityRecoverableExclusiveTaxRecoverableInclusiveTaxRequesterRequesterDisplayNameRequesterIdRequisitionRequisitionDistributionRequisitionDistributionIdRequisitionHeaderIdRequisitionLineRequisitionLineIdScheduleNumberStatusStatusCodeTotalTotalTaxUOMUOMCodeDFFGET Flexfields for Distributions · 3 fieldsPoDistributionId__FLEX_Context__FLEX_Context_DisplayValueglobalDFFsGET US Federal Attributes for DistributionsFields depend on your pod's flexfield setup (check
/describe).projectDFFGET Project Costing Flexfields for DistributionsFields depend on your pod's flexfield setup (check
/describe).globalDFFsGET US Federal Attributes for SchedulesFields depend on your pod's flexfield setup (check
/describe).specialHandlingDFFGET Special Handling Flexfields for Purchase Orders LinesFields depend on your pod's flexfield setup (check
/describe).specialHandlingDFFGET Special Handling Flexfields for Purchase OrdersFields depend on your pod's flexfield setup (check
/describe).supportingDocumentsGET Supporting Documents for Contract Terms · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNametemplateUsagesGET Template Usages · 15 fieldsAuthoringPartyAuthoringPartyCodeContractExpertEnabledContractSourceCodeCreatedByCreationDateDescriptionDocumentNumberLastUpdateDateLastUpdatedBySimpleContractTextSimpleContractYnSourceCodeTemplateIdTemplateNameContractFormAttachmentGET Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserName
Actions 21
POST …/{purchaseOrdersUniqID}/action/acknowledge·supplierOrderacknowledgementNotePOST …/{purchaseOrdersUniqID}/action/cancel·acknowledgeWithinDayscommunicationMethodcancellationReasonrequiredAcknowledgmentCCEmailBCCEmailinitiatingPartyfaxemailcancelUnfulfilledDemandFlagPOST …/{purchaseOrdersUniqID}/action/close·closeActioncloseReasonPOST …/{purchaseOrdersUniqID}/action/communicate·forceCommunicationFlagchangeOrderNumberPOST …/{purchaseOrdersUniqID}/action/communicateOnePurchaseOrder·ccpreferredLanguagebcccommunicationMethodfaxemailPOST …/{purchaseOrdersUniqID}/action/duplicate·copyAttachmentscopyContractTermsPOST …/{purchaseOrdersUniqID}/action/freeze·freezeReasonPOST …/{purchaseOrdersUniqID}/action/generateHighlightsPOST …/{purchaseOrdersUniqID}/action/hold·holdReasonPOST …/{purchaseOrdersUniqID}/action/removeHold·removeHoldReasonPOST …/{purchaseOrdersUniqID}/action/renumberPO·newOrderNumberPOST …/{purchaseOrdersUniqID}/action/reopen·reopenActionreopenBudgetDatereopenReasonPOST …/{purchaseOrdersUniqID}/action/submit·bypassApprovalsFlagPOST …/{purchaseOrdersUniqID}/action/unfreeze·unfreezeReasonPOST …/{purchaseOrdersUniqID}/action/viewMasterContractPOST …/{purchaseOrdersUniqID}/action/viewPDFPOST …/{purchaseOrdersUniqID}/child/lines/{POLineId}/action/close·closeActioncloseReasonPOST …/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/action/close·closeActioncloseReasonPOST …/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/action/firm·firmReasonPOST …/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/action/reopen·reopenActionreopenBudgetDatereopenReasonPOST …/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/action/unfirm·unfirmReason
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/purchaseOrdersand 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:BillToLocation, notbilltolocation. 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.