1. REST API for Oracle Procurement Cloud
  2. Tasks
  3. Purchase Orders

Get all purchase orders

get

/fscmRestApi/resources/11.13.18.05/purchaseOrders

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a purchase order according to the purchase order identifier.
      Finder Variables:
      • POHeaderId; integer; Value that uniquely identifies a purchase order.
    • findByIntent: Finds purchase orders according to the intent.
      Finder Variables:
      • Intent; string; Value that uniquely identifies the intent. Valid values are APUser, POUser, LOBUser, SSPUser, and NonAgentUser.
      • POHeaderId; integer; Value that uniquely identifies the purchase order.
      • SysEffectiveDate; object.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcknowledgmentDueDate; string; Date that the application requests the supplier to acknowledge the purchase order.
    • BillToBU; string; Business unit that processes supplier invoices for the purchase order.
    • BillToBUId; integer; Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
    • BillToLocation; string; Bill-to location where the supplier must send the invoice.
    • BillToLocationId; integer; Value that uniquely identifies the bill-to location.
    • Buyer; string; Person who is responsible for managing the purchase order.
    • BuyerDisplayName; string; Display name of the person who is responsible for managing the purchase order.
    • BuyerId; integer; Value that uniquely identifies the buyer.
    • BuyerManagedTransportFlag; boolean; Contains one of the following values: true or false. If true, then the buyer or an agent that the buyer designates must arrange transportation, from picking up the requested item to delivering it to the ship-to location that the purchase order specifies. If false, then the supplier must arrange transportation.
    • CreatedBy; string; User who created the purchase order.
    • CreationDate; string; Date and time when the buyer or application creates the purchase order.
    • Currency; string; Purchase order currency.
    • CurrencyCode; string; Abbreviation that identifies the purchase order currency.
    • Description; string; Description of the purchase order.
    • DocumentStyle; string; Value that identifies the purchasing document style.
    • DocumentStyleId; integer; Value that uniquely identifies the purchasing style of the document.
    • LastUpdateDate; string; Date and time when the buyer or application most recently updated the purchase order.
    • LastUpdatedBy; string; User who most recently updated the purchase order.
    • MasterContractId; integer; Value that uniquely identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud.
    • MasterContractNumber; string; Number that identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud.
    • OrderNumber; string; Number that uniquely identifies the purchase order in the sold-to legal entity.
    • OverrideB2BCommunicationFlag; boolean; Contains one of the following values: true or false. If true, the purchase order can't be communicated using B2B communication, and you can communicate it using an alternate communication method such as email. If false, the purchase order must be communicated using B2B communication when the supplier site is configured to receive B2B messages.
    • OverridingApprover; string; Overriding first approver identifier to route purchase orders for approval.
    • OverridingApproverId; integer; Value that uniquely identifies the user specified on the purchase order as the overriding approver for approval routing.
    • POHeaderId; integer; Value that uniquely identifies the purchase order.
    • ProcurementBU; string; Business unit that manages and owns the purchase order.
    • ProcurementBUId; integer; Value that uniquely identifies the business unit that manages and owns the purchase order.
    • ProgressPaymentFlag; boolean; Contains one of the following values: true or false. If true, then the progress payment is enabled for the style. If false, then the progress payment isn't enabled for the style. This attribute doesn't have a default value.
    • RequiresSignatureFlag; boolean; Contains one of the following values: true or false. If true, then the purchase order requires signatures to meet legal requirements. If false, then the purchase order does not require signatures.
    • RequisitioningBU; string; Business unit that creates the requisition.
    • RequisitioningBUId; integer; Value that uniquely identifies the business unit that creates the requisition.
    • SoldToLegalEntity; string; Party who is financially responsible for purchases on the purchase order.
    • SoldToLegalEntityId; integer; Value that uniquely identifies the legal entity that's financially responsible for purchases on the purchase order.
    • SpecialHandlingType; string; Type, such as bill-only, that describes the behavior of purchasing documents that need to be handled in a special manner.
    • SpecialHandlingTypeCode; string; Abbreviation that identifies the special handling type.
    • Status; string; Status of the purchase order relative to the purchase order life cycle.
    • StatusCode; string; Abbreviation that identifies the purchase order status in the order life cycle.
    • Supplier; string; Supplier who fulfills the item.
    • SupplierBccEmailAddress; string; Email address to which a copy of the purchase order communication email is sent without letting other recipients know.
    • SupplierCcEmailAddress; string; Email address to which a copy of the purchase order communication email is sent.
    • SupplierCommunicationMethod; string; Method by which the purchase order is communicated to the supplier, such as email or fax.
    • SupplierCommunicationMethodCode; string; Method by which the purchase order is communicated to the supplier, such as email or fax.
    • SupplierEmailAddress; string; Email address of the supplier for communication.
    • SupplierFax; string; Fax number used to communicate the purchase order to the supplier.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierSite; string; Location that the supplier uses to purchase the item.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : purchaseOrders
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : purchaseOrders-item-response
Type: object
Show Source
  • Title: Acknowledge Within Days
    Read Only: true
    Number of days the supplier can decide to accept or reject the purchase order.
  • Title: Acknowledgment Due Date
    Read Only: true
    Date that the application requests the supplier to acknowledge the purchase order.
  • Title: Additional Contact Email
    Read Only: true
    Maximum Length: 2000
    Email addresses of additional supplier contacts. These email addresses are used to send purchase orders to supplier contacts involved in the procurement process.
  • Attachments for Purchase Orders
    Title: Attachments for Purchase Orders
    The Attachments for Purchase Orders resource manage attachments for a purchase order.
  • Title: Bill-to BU
    Read Only: true
    Maximum Length: 240
    Business unit that processes supplier invoices for the purchase order.
  • Read Only: true
    Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
  • Title: Bill-to Location
    Bill-to location where the supplier must send the invoice.
  • Read Only: true
    Value that uniquely identifies the bill-to location.
  • Title: Buyer
    Read Only: true
    Maximum Length: 240
    Person who is responsible for managing the purchase order.
  • Title: Buyer
    Read Only: true
    Maximum Length: 240
    Display name of the person who is responsible for managing the purchase order.
  • Read Only: true
    Value that uniquely identifies the buyer.
  • Title: Buyer Managed Transportation
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the buyer or an agent that the buyer designates must arrange transportation, from picking up the requested item to delivering it to the ship-to location that the purchase order specifies. If false, then the supplier must arrange transportation.
  • Title: Carrier
    Read Only: true
    Maximum Length: 360
    Company that transports the item through land, sea, or air.
  • Read Only: true
    Value that uniquely identifies the company that transports the item through land, sea, or air.
  • Title: Confirming Order
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the document confirms that the supplier is aware of the purchase order. If false, then the supplier isn't aware of the purchase order.
  • Title: Consignment Terms Enabled
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the document style supports consignment. If false, then the document style doesn't support consignment.
  • Title: Conversion Rate
    Read Only: true
    Conversion rate to use when converting the currency.
  • Title: Conversion Date
    Read Only: true
    Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.
  • Title: Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    Rate type that the application uses to determine the currency conversion rate for the purchase order.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase order.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application creates the purchase order.
  • Title: Credit
    Read Only: true
    Total of the amounts from the purchase order lines with a credit line type.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Taxation Country
    Read Only: true
    Maximum Length: 80
    Country where the transaction takes place. This attribute is used for taxation.
  • Title: Taxation Country
    Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country for taxation.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the purchase order.
  • Flexfields for Purchase Orders
    Title: Flexfields for Purchase Orders
    The Flexfields for Purchase Orders resource manages additional details about purchase orders.
  • Title: Discount
    Read Only: true
    Total of the discount amounts from the purchase order lines.
  • Title: Document Fiscal Classification
    Read Only: true
    Maximum Length: 1996
    Tax classification used by a tax authority to categorize a document.
  • Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the document fiscal classification.
  • Read Only: true
    Value that uniquely identifies the document fiscal classification.
  • Title: Document Style
    Read Only: true
    Maximum Length: 240
    Value that identifies the purchasing document style.
  • Read Only: true
    Value that uniquely identifies the purchasing style of the document.
  • Read Only: true
    Value that uniquely identifies the first party registration number.
  • Title: First-Party Tax Registration Number
    Read Only: true
    Maximum Length: 50
    Value that is a unique sequence of letters or numbers assigned to a first party by a tax authority when it is registered. This attribute is used to identify the first party registration.
  • Title: FOB
    Read Only: true
    Maximum Length: 80
    Free on board. Location where ownership of the item transfers from the supplier to the buyer.
  • Title: FOB
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of term for free on board for the item.
  • Title: Freight Terms
    Read Only: true
    Maximum Length: 80
    Terms that describe who pays charges to transport the item.
  • Title: Freight Terms
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the type of freight terms for the purchase order.
  • Title: Frozen
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the purchase order is frozen and modifications are not allowed. If false, then the purchase order is not frozen.
  • US Federal Attributes for Purchase Orders
    Title: US Federal Attributes for Purchase Orders
    The US Federal Attributes for Purchase Orders resource manages federal financial attributes for purchase orders.
  • Title: Import Source
    Read Only: true
    Maximum Length: 25
    Value that indicates the source application from which the purchase order was imported.
  • Read Only: true
    Date and time when the buyer or application most recently updated the purchase order.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the purchase order.
  • Lines
    Title: Lines
    The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price.
  • Links
  • Read Only: true
    Value that uniquely identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud.
  • Title: Master Contract
    Read Only: true
    Maximum Length: 120
    Number that identifies the contract from enterprise contracts. This attribute allows a direct connection between execution documents in Oracle Purchasing Cloud and high-level contracts in Oracle Enterprise Contracts Cloud.
  • Title: Master Contract Type
    Type of contract. This attribute specifies the nature of the enterprise contract. The contract type specifies what kind of information you can enter including the presence of lines and contract terms.
  • Value that uniquely identifies the contract type. This attribute specifies the nature of the enterprise contract. The contract type specifies what kind of information you can enter including the presence of lines and contract terms.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 80
    Mode of transport that the shipper uses to transport the item, such as land, sea, or air.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the mode of transport.
  • Title: Negotiation
    Read Only: true
    Maximum Length: 255
    Number that uniquely identifies the negotiation that the purchase order line references.
  • Title: Note to Receiver
    Read Only: true
    Maximum Length: 1000
    Note that the receiver can read to get details about how to process the purchase order.
  • Title: Note to Supplier
    Read Only: true
    Maximum Length: 1000
    Note that the supplier can read to get details about how to process the purchase order.
  • Title: Order Date
    Read Only: true
    The date on which the purchase order was communicated to the supplier.
  • Title: Ordered
    Read Only: true
    Total of the amounts from the purchase order lines. Doesn't include exclusive taxes.
  • Title: Ordered Before Adjustments
    Read Only: true
    Total of the amounts from the purchase order lines. Does not include credits, discounts, or exclusive taxes.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Title: Override B2B communication
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, the purchase order can't be communicated using B2B communication, and you can communicate it using an alternate communication method such as email. If false, the purchase order must be communicated using B2B communication when the supplier site is configured to receive B2B messages.
  • Title: Overriding Approver
    Read Only: true
    Maximum Length: 240
    Overriding first approver identifier to route purchase orders for approval.
  • Title: Overriding Approver
    Read Only: true
    Maximum Length: 240
    Name of the user specified on the purchase order as the overriding approver for the approval routing.
  • Read Only: true
    Value that uniquely identifies the user specified on the purchase order as the overriding approver for approval routing.
  • Title: Payment Terms
    Read Only: true
    Maximum Length: 50
    Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
  • Read Only: true
    Value that uniquely identifies the payment terms.
  • Title: Pay on Receipt
    Read Only: true
    Maximum Length: 25
    Contains one of the following values: true or false. If true, then the application creates an invoice that requests payment for the item according to the receipt transaction. If false, then the application does not require the supplier to create this invoice and instead requests payment according to the receipt of the shipped item.
  • Read Only: true
    Value that uniquely identifies the purchase order.
  • Title: Procurement BU
    Read Only: true
    Maximum Length: 240
    Business unit that manages and owns the purchase order.
  • Read Only: true
    Value that uniquely identifies the business unit that manages and owns the purchase order.
  • Title: Progress Payments Enabled
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the progress payment is enabled for the style. If false, then the progress payment isn't enabled for the style. This attribute doesn't have a default value.
  • Title: Purchase Basis
    Read Only: true
    Value that indicates whether the line is for goods or services.
  • Title: Reference Number
    Read Only: true
    Maximum Length: 120
    Document number of the purchase order that the import imported from the legacy application into Oracle Purchasing Cloud.
  • Title: Requester
    Read Only: true
    Name of the deliver-to person or requester if unique among all distributions, else Multiple.
  • Read Only: true
    Value that uniquely identifies the deliver-to person or requester.
  • Title: Required Acknowledgment
    Read Only: true
    Maximum Length: 80
    Acknowledgment that the application requires from the supplier. Values include Document and Schedule when supplier must acknowledge the header and schedule of the purchase order, Document when supplier must acknowledge the header of the purchase order, or None when the purchase order does not require acknowledgment.
  • Title: Required Acknowledgment
    Read Only: true
    Maximum Length: 1
    Abbreviation that identifies the acknowledgment that the purchase order requires from the supplier. Values include Y for document and schedule, D for document, or N for none.
  • Title: Requires signature
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the purchase order requires signatures to meet legal requirements. If false, then the purchase order does not require signatures.
  • Title: Requisition
    Read Only: true
    Maximum Length: 255
    Number that identifies the requisition.
  • Title: Requisitioning BU
    Read Only: true
    Maximum Length: 240
    Business unit that creates the requisition.
  • Read Only: true
    Value that uniquely identifies the business unit that creates the requisition.
  • Title: Revision
    Read Only: true
    Versions of the purchase order that requires communication to and, as an option, get acknowledgment from the supplier.
  • Title: Customer Sales Order
    Read Only: true
    Maximum Length: 255
    Identifies the sales order that's to be fulfilled by the material being procured.
  • Title: Service Level
    Read Only: true
    Maximum Length: 80
    Priority that determines how quickly to transport the item.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the service level for the shipping method.
  • Title: Shipping Method
    Read Only: true
    Maximum Length: 255
    Transportation method for the carrier or service level for the purchase order. For example, ABC Shipping - AIR - 2nd Day.
  • Title: Ship-to Location Address
    Read Only: true
    Value that identifies the common internal or external address where the supplier ships all the items.
  • Title: Ship-to Location Code
    Read Only: true
    Abbreviation that identifies the location when items are shipped to an internal location.
  • Read Only: true
    Value that uniquely identifies the common internal or external location where the supplier ships all the items.
  • Title: Sold-to Legal Entity
    Read Only: true
    Maximum Length: 240
    Party who is financially responsible for purchases on the purchase order.
  • Read Only: true
    Value that uniquely identifies the legal entity that's financially responsible for purchases on the purchase order.
  • Title: Source Agreement
    Read Only: true
    Maximum Length: 255
    Number that uniquely identifies the source agreement that the purchase order line references.
  • Special Handling Flexfields for Purchase Orders
    Title: Special Handling Flexfields for Purchase Orders
    A flexible data field that includes the special handling extensible flexfields for purchase orders.
  • Title: Special Handling Type
    Read Only: true
    Maximum Length: 30
    Type, such as bill-only, that describes the behavior of purchasing documents that need to be handled in a special manner.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the special handling type.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order relative to the purchase order life cycle.
  • Title: Status Code
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the purchase order status in the order life cycle.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    Supplier who fulfills the item.
  • Title: Bcc
    Read Only: true
    Maximum Length: 2000
    Email address to which a copy of the purchase order communication email is sent without letting other recipients know.
  • Title: Cc
    Read Only: true
    Maximum Length: 2000
    Email address to which a copy of the purchase order communication email is sent.
  • Title: Communication Method
    Read Only: true
    Maximum Length: 80
    Method by which the purchase order is communicated to the supplier, such as email or fax.
  • Title: Communication Method
    Read Only: true
    Maximum Length: 25
    Method by which the purchase order is communicated to the supplier, such as email or fax.
  • Title: Supplier Contact
    Read Only: true
    Maximum Length: 360
    Person who represents the supplier when communicating with the buyer.
  • Title: Supplier Contact
    Read Only: true
    Maximum Length: 360
    Display name of the person who represents the supplier when communicating with the buyer.
  • Read Only: true
    Value that uniquely identifies the supplier contact.
  • Title: Email
    Read Only: true
    Maximum Length: 2000
    Email address of the supplier for communication.
  • Title: Fax
    Read Only: true
    Maximum Length: 60
    Fax number used to communicate the purchase order to the supplier.
  • Read Only: true
    Value that uniquely identifies the supplier.
  • Title: Supplier Order
    Read Only: true
    Maximum Length: 25
    Document number that the supplier created for the purchase order.
  • Title: Supplier Site
    Read Only: true
    Maximum Length: 240
    Location that the supplier uses to purchase the item.
  • Read Only: true
    Value that uniquely identifies the supplier site.
  • Read Only: true
    Value that uniquely identifies the third party registration.
  • Title: Third-Party Tax Registration Number
    Read Only: true
    Maximum Length: 50
    Value that is a unique sequence of letters or numbers assigned to a third party or third-party site by a tax authority. This attribute is used to identify the party or party-site level tax registration.
  • Title: Total
    Read Only: true
    Ordered amount plus the exclusive tax amounts for the purchase order.
  • Title: Total Tax
    Read Only: true
    Exclusive tax amount that the purchase can recover and not recover for the purchase order.
Nested Schema : Attachments for Purchase Orders
Type: array
Title: Attachments for Purchase Orders
The Attachments for Purchase Orders resource manage attachments for a purchase order.
Show Source
Nested Schema : Flexfields for Purchase Orders
Type: array
Title: Flexfields for Purchase Orders
The Flexfields for Purchase Orders resource manages additional details about purchase orders.
Show Source
Nested Schema : US Federal Attributes for Purchase Orders
Type: array
Title: US Federal Attributes for Purchase Orders
The US Federal Attributes for Purchase Orders resource manages federal financial attributes for purchase orders.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSPOHeaders":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poHeaderGdf_view_PoHeaderGDFFVxUSPOHeadersVO-item-response" } }
Nested Schema : Lines
Type: array
Title: Lines
The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price.
Show Source
Nested Schema : Special Handling Flexfields for Purchase Orders
Type: array
Title: Special Handling Flexfields for Purchase Orders
A flexible data field that includes the special handling extensible flexfields for purchase orders.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "ORA_PO_BILL_ONLY_HEADERS":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poHeaderSHdf_view_POHeaderSHORA__5FPO__5FBILL__5FONLY__5FHEADERSVO-item-response" } }
Nested Schema : purchaseOrders-attachments-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-DFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poHeaderGdf_view_PoHeaderGDFFVxUSPOHeadersVO-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-item-response
Type: object
Show Source
  • Attachments for Lines
    Title: Attachments for Lines
    The Attachments for Lines resource manage attachments for a purchase order line.
  • Title: Base Price
    Read Only: true
    Original price for each unit of the offered item or service. This attribute is associated with a feature that requires opt in.
  • Title: Category Name
    Read Only: true
    Maximum Length: 2400
    Name of the purchasing category that the purchase order uses to classify the purchase for the order line.
  • Read Only: true
    Maximum Length: 820
    Abbreviation that identifies the purchasing category.
  • Read Only: true
    Value that uniquely identifies the purchasing category.
  • Title: Consignment Line
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the item on the purchase order is under consignment. If false, then the item isn't under consignment.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase order line.
  • Read Only: true
    Date and time when the buyer or application created the purchase order line.
  • Title: Credit Flag
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the line is a credit line and the price associated with the line is a negative value. If false, then the line isn't a credit line and represents either an item or a service.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the item that the purchase order references.
  • Flexfields for Lines
    Title: Flexfields for Lines
    The Flexfields for Lines resource manages additional details about purchase order lines.
  • Title: Discount
    Read Only: true
    Value that indicates the discount percent or amount of the purchase order line.
  • Title: Discount Reason
    Read Only: true
    Maximum Length: 240
    Reason for the discount.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Type of discount that indicates whether the discount is based on amount or percent.
  • Title: Hazard Class
    Read Only: true
    Maximum Length: 40
    Name of the hazard class that's used to identify and classify hazardous materials to comply with the safety regulations.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the hazard class.
  • Read Only: true
    Value that uniquely identifies the hazard class.
  • Title: Item
    Read Only: true
    Abbreviation that uniquely identifies the item on the purchase order.
  • Read Only: true
    Value that uniquely identifies the item on the purchase order.
  • Title: Item Revision
    Read Only: true
    Maximum Length: 18
    Revision number of the item.
  • Read Only: true
    Date and time when the buyer or application most recently updated the purchase order line.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the purchase order line.
  • Title: Line
    Read Only: true
    Number that uniquely identifies the purchase order line.
  • Title: Line Type
    Read Only: true
    Maximum Length: 30
    Type that indicates whether the purchase order line references an item or a service.
  • Read Only: true
    Value that uniquely identifies whether the purchase order line references an item or a service.
  • Links
  • Title: Manufacturer
    Read Only: true
    Maximum Length: 700
    Name of the manufacturer of the item.
  • Title: Manufacturer Part Number
    Read Only: true
    Maximum Length: 700
    Number issued by the manufacturer that uniquely identifies the individual product.
  • Title: Maximum Retainage Amount
    Read Only: true
    Maximum amount of retainage that can be withheld on a contract line.
  • Title: Negotiated
    Read Only: true
    Maximum Length: 1
    Contains 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 did not negotiate the price before the purchase.
  • Title: Negotiation
    Read Only: true
    Maximum Length: 240
    Number that uniquely identifies the negotiation that the purchase order line references.
  • Read Only: true
    Value that uniquely identifies the negotiation that the purchase order line references.
  • Title: Negotiation Line
    Read Only: true
    Number that uniquely identifies the negotiation line that the purchase order line references.
  • Title: Note to Supplier
    Read Only: true
    Maximum Length: 1000
    Note that the supplier can read to get details about how to process the order line on the purchase order.
  • Title: Ordered
    Read Only: true
    Price multiplied by quantity. The purchase order uses this value when the purchase order line contains a quantity. If the purchase order line references a fixed price service, then this attribute contains the same value that the scheduled amount contains.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Read Only: true
    Value that uniquely identifies the purchase order.
  • Read Only: true
    Value that uniquely identifies the purchase order line.
  • Title: Price
    Read Only: true
    Price of the purchase order line.
  • Title: Pricing UOM
    Read Only: true
    Maximum Length: 25
    Unit of measure that the item uses for pricing.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure the item uses for pricing.
  • Title: Quantity
    Read Only: true
    Quantity of the item on the order line.
  • Schedules
    Title: Schedules
    The Schedules resource manages purchasing details, such as ship-to location and delivery date.
  • Title: Secondary Quantity
    Read Only: true
    Quantity on the order line in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Title: Secondary UOM
    Read Only: true
    Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.
  • Read Only: true
    Abbreviation that identifies the quantity on the order line in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Read Only: true
    Value that uniquely identifies the source agreement that the purchase order line references.
  • Title: Source Agreement Line
    Read Only: true
    Number that uniquely identifies the source agreement line that the purchase order line references.
  • Read Only: true
    Value that uniquely identifies the source agreement line that the purchase order line references.
  • Title: Source Agreement
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the source agreement that the purchase order line references.
  • Title: Source Agreement Procurement BU
    Business unit of the purchase agreement against which this purchase order line is released.
  • Read Only: true
    Value that uniquely identifies the business unit of the purchase agreement against which this purchase order line is released.
  • Title: Source Agreement Document Type
    Read Only: true
    Maximum Length: 80
    Specifies whether the agreement is a blanket purchase agreement or a contract purchase agreement.
  • Read Only: true
    Maximum Length: 25
    Source agreement type. For example, CONTRACT or BLANKET.
  • Special Handling Flexfields for Purchase Order Lines
    Title: Special Handling Flexfields for Purchase Order Lines
    A flexible data field that includes the special handling extensible flexfields for purchase order lines.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order line.
  • Title: Line Status
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the status of the purchase order line.
  • Title: Supplier Configuration ID
    Read Only: true
    Maximum Length: 150
    Value that uniquely identifies the configured item that the requester created in the supplier application when creating the requisition.
  • Title: Supplier Item
    Read Only: true
    Maximum Length: 300
    Number that the supplier uses to identify the item on the purchase order line.
  • Title: Total
    Read Only: true
    Ordered amount plus the exclusive tax amounts on the purchase order line.
  • Title: Total Tax
    Read Only: true
    Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order line.
  • Title: UN Number
    Read Only: true
    Maximum Length: 20
    Number that the United Nations uses to identify hazardous material.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Title: UN Number Description
    Read Only: true
    Maximum Length: 240
    Description of the hazardous material that the United Nations identification number references.
  • Read Only: true
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Unit of measure that the item uses for the quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
  • Title: Product
    Read Only: true
    Maximum Length: 300
    Finished item that the work order in contract manufacturing creates.
Nested Schema : Attachments for Lines
Type: array
Title: Attachments for Lines
The Attachments for Lines resource manage attachments for a purchase order line.
Show Source
Nested Schema : Flexfields for Lines
Type: array
Title: Flexfields for Lines
The Flexfields for Lines resource manages additional details about purchase order lines.
Show Source
Nested Schema : Schedules
Type: array
Title: Schedules
The Schedules resource manages purchasing details, such as ship-to location and delivery date.
Show Source
Nested Schema : Special Handling Flexfields for Purchase Order Lines
Type: array
Title: Special Handling Flexfields for Purchase Order Lines
A flexible data field that includes the special handling extensible flexfields for purchase order lines.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "ORA_PO_BILL_ONLY_LINES":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poLineSHdf_view_POLineSHORA__5FPO__5FBILL__5FONLY__5FLINESVO-item-response" } }
Nested Schema : purchaseOrders-lines-attachments-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-DFF-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-schedules-item-response
Type: object
Show Source
  • Title: Accrue at Receipt
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then accrue the purchase order schedule at receipt. If false, then don't accrue it at receipt.
  • Title: Allow Substitute Receipts
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the purchase order schedule allows the application to use a substitute item in place of the ordered item. If false, then the purchase order schedule does not allow a substitute item.
  • Title: Assessable Value
    Read Only: true
    Value of the product that can be assessable.
  • Attachments for Schedules
    Title: Attachments for Schedules
    The Attachments for Schedules resource manage attachments for a purchase order schedule.
  • Title: Back-to-Back Order
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the sales order exists for the purchase order schedule, and use back-to back-fulfillment. The purchase order schedule fulfills the sales order upon receipt. If false, then the sales order does not exist for the purchase order schedule.
  • Title: Invoice Matched
    Read Only: true
    Amount equivalent of the matched invoice lines based on the purchase price.
  • Title: Invoiced Quantity
    Read Only: true
    Quantity invoiced against the purchase order schedule.
  • Title: Carrier
    Read Only: true
    Maximum Length: 360
    Company that transports the item.
  • Read Only: true
    Value that uniquely identifies the company that transports the item.
  • Title: Country of Origin
    Read Only: true
    Maximum Length: 80
    Country where the organization that ships and exports the item resides.
  • Title: Country of Origin
    Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country where the organization resides that ships and exports the item.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase order schedule.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application created the purchase order schedule.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Customer Item
    Read Only: true
    Maximum Length: 25
    Value that identifies the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Item Description
    Read Only: true
    Maximum Length: 240
    Description of the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order Line
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order line for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order Schedule
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order schedule for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work associated with the progress payment schedule.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 80
    Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 25
    How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING.
  • Flexfields for Schedules
    Title: Flexfields for Schedules
    The Flexfields for Schedules resource manages additional details about purchase order schedules.
  • Distributions
    Title: Distributions
    The Distributions resource manages purchasing details, such as details about accounting or the project.
  • Title: Early Receipt Tolerance in Days
    Read Only: true
    Maximum number of days the application allows to receive an early shipment.
  • Title: Firm
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the schedule cannot be changed by the manufacturing application. If false, then the schedule can be changed by the manufacturing application. This attribute does not have a default value.
  • US Federal Attributes for Schedules
    Title: US Federal Attributes for Schedules
    The US Federal Attributes for Schedules resource manages federal financial attributes for purchase order schedules.
  • Title: Invoice Close Tolerance Percent
    Read Only: true
    Percent that the application uses to determine whether to close a purchase order schedule when the invoice invoices only part of the item.
  • Title: Invoice Match Option
    Read Only: true
    Maximum Length: 80
    Determines whether to match the invoice to the purchase order or the receipt. If the purchase order line is under consignment, then match each invoice to the consumption advice.
  • Title: Invoice Match Option
    Read Only: true
    Maximum Length: 25
    Determines whether the invoice for the purchase order schedule must match the purchase order or the receipt. Values include C for consumption advice, P for order, or R for receipt.
  • Title: Last Acceptable Delivery Date
    Read Only: true
    Last date when the shipper can deliver the item.
  • Title: Last Acceptable Ship Date
    Read Only: true
    Last date when the shipper can ship the item.
  • Read Only: true
    Last date when the receiver can receive the item.
  • Read Only: true
    Date and time when the buyer or application most recently updated the purchase order schedule.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the purchase order schedule.
  • Title: Late Receipt Tolerance in Days
    Read Only: true
    Maximum number of days the application allows to receive a late shipment.
  • Title: Intended Use
    Read Only: true
    Maximum Length: 240
    Purpose for which a product is likely to be used in the business by the purchaser.
  • Title: Intended Use
    Read Only: true
    Value that uniquely identifies the intended use of a product in the business by the purchaser.
  • Read Only: true
    Value that uniquely identifies the purchase order schedule.
  • Title: Line
    Read Only: true
    Number that uniquely identifies the purchase order line.
  • Links
  • Title: Location of Final Discharge
    Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the final discharge location.
  • Read Only: true
    Value that uniquely identifies the final discharge location.
  • Title: Match Approval Level
    Read Only: true
    Specifies how quantities on the purchase order, receipt, inspection, and invoice must match before the buyer can pay the invoice. Values include 2-Way, 3-Way, or 4-Way.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 80
    Mode of transportation that ships the item, such as truck, air, or boat.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the mode of transport.
  • Title: Note to Receiver
    Read Only: true
    Maximum Length: 1000
    Note that the receiver can read to get details about how to process the purchase order schedule.
  • Read Only: true
    Number that identifies the orchestration agreement line.
  • Title: Financial Orchestration Flow
    Read Only: true
    Maximum Length: 100
    Number that identifies the orchestration agreement between the legal entities, business units, and trade organizations establishing a trade relationship.
  • Title: Ordered
    Read Only: true
    Price multiplied by the scheduled quantity. If the purchase order line references a fixed price service, then this attribute contains the same value that the scheduled amount contains.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Title: Original Promised Delivery Date
    Read Only: true
    Date when the supplier promises to deliver the item that the buyer ordered.
  • Title: Original Promised Ship Date
    Read Only: true
    Date when the supplier promises to ship the item that the buyer ordered.
  • Title: Overreceipt Action
    Read Only: true
    Maximum Length: 80
    Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include None, Reject, or Warning.
  • Title: Overreceipt Action
    Read Only: true
    Maximum Length: 25
    Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include NONE, REJECT, or WARNING.
  • Title: Overreceipt Tolerance Percent
    Read Only: true
    Percent tolerance to use when receiving more than the ordered quantity or amount without starting the action that the OverReceiptActionCode attribute specifies.
  • Read Only: true
    Value that uniquely identifies the purchase order.
  • Read Only: true
    Value that uniquely identifies the parent of the purchase order line.
  • Read Only: true
    Name of the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Read Only: true
    Abbreviation that identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Read Only: true
    Value that uniquely identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Title: Price
    Read Only: true
    Price of the purchase order line.
  • Title: Pricing UOM
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the unit of measure the item uses for pricing.
  • Read Only: true
    Maximum Length: 3
    Unit of measure that the item uses for pricing.
  • Read Only: true
    Value that uniquely identifies the primary trade relationship in an orchestration agreement.
  • Title: Product Category
    Read Only: true
    Maximum Length: 1996
    Name of the category used to classify products for tax purposes.
  • Title: Product Category
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the category used to classify products for tax purposes.
  • Title: Product Fiscal Classification
    Read Only: true
    Maximum Length: 240
    Tax classification used by a tax authority to categorize a product.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the fiscal classification of a product by tax authority for tax purposes.
  • Read Only: true
    Value that uniquely identifies the fiscal classification of a product by tax authority for tax purposes. It is based on the inventory item category.
  • Title: Product Type
    Read Only: true
    Maximum Length: 80
    Value that determines how the tax is calculated. Values include goods and services.
  • Title: Product Type
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the product type.
  • Title: Promised Delivery Date
    Read Only: true
    Date when the supplier promises to deliver the item to the buyer.
  • Title: Promised Ship Date
    Read Only: true
    Date when the supplier promises to ship the item to the buyer.
  • Title: Quantity
    Read Only: true
    Scheduled quantity of the item.
  • Title: Receipt Close Tolerance Percent
    Read Only: true
    Percent that the application uses to determine whether to close a purchase order schedule when the receiver receives only part of the item.
  • Title: Receipt Date Exception Action
    Read Only: true
    Maximum Length: 80
    Action to take when the buyer does not receive the purchase ordered quantity or does not receive the amount before the value that the Late Receipt Tolerance Days attribute specifies. Values include None, Reject, or Warning.
  • Title: Receipt Date Exception Action
    Read Only: true
    Maximum Length: 25
    Action to take when the application does not receive the purchase ordered quantity or amount before the value that the Late Receipt Tolerance Days attribute specifies. Values include NONE, REJECT, or WARNING.
  • Title: Receipt Routing
    Read Only: true
    Maximum Length: 80
    Routing to use when receiving the item. Values include Standard Receipt, Inspection Required, or Direct Delivery.
  • Title: Receipt Routing
    Read Only: true
    How to simplify transaction entry when routing the receipt. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
  • Title: Received
    Read Only: true
    Amount received for service lines.
  • Title: Received Quantity
    Read Only: true
    Quantity received against the purchase order schedule.
  • Title: Requested Delivery Date
    Read Only: true
    Date when the buyer requests that the supplier deliver the item.
  • Title: Requested Ship Date
    Read Only: true
    Date when the buyer requests that the supplier ship the item.
  • Title: Retainage
    Read Only: true
    Total amount withheld as retainage against the schedule.
  • Title: Retainage Rate
    Read Only: true
    Percentage of the invoice value that can be withheld as retainage.
  • Title: Retainage Released
    Read Only: true
    Amount of retainage released for the schedule.
  • Title: Customer Sales Order Line
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order line that the purchase order schedule references.
  • Title: Customer Sales Order
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order that the purchase order schedule references.
  • Title: Customer Sales Order Schedule
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order schedule that the purchase order schedule references.
  • Title: Schedule
    Read Only: true
    Number that uniquely identifies the purchase order schedule for the purchase order line.
  • Title: Secondary Quantity
    Read Only: true
    Scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Title: Secondary UOM
    Read Only: true
    Maximum Length: 25
    Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Title: Shipping Method
    Read Only: true
    Maximum Length: 255
    Shipping method on the purchase order schedule.
  • Title: Ship-to Party
    Read Only: true
    Maximum Length: 360
    Name of the party who receives the item that the supplier ships.
  • Title: Ship-to Customer Contact
    Read Only: true
    Maximum Length: 360
    Name of the contact from the company where the goods are shipped.
  • Read Only: true
    Value that uniquely identifies the contact from the company where the goods are shipped.
  • Read Only: true
    Value that uniquely identifies the third party that receives the item.
  • Title: Ship-to Customer Location
    Read Only: true
    Maximum Length: 255
    Value that identifies the external address where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the external location where the supplier ships the item.
  • Title: Ship-to Exception Action
    Read Only: true
    Maximum Length: 80
    Action to take if an exception occurs when the receiving location is different from the ship-to location. Values include None, Reject, and Warning.
  • Title: Ship-to Exception Action
    Read Only: true
    Maximum Length: 25
    How to handle each receipt when the receiving location is different from the ship-to location. Values include NONE, REJECT, or WARNING.
  • Title: Location
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the location where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the location where the supplier ships the item.
  • Title: Ship-to Organization
    Read Only: true
    Maximum Length: 240
    Name of the inventory organization that receives the item.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the inventory organization where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the inventory organization where the supplier ships the item.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order schedule.
  • Title: Status
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the status of the purchase order schedule.
  • Title: Supplier Order
    Read Only: true
    Maximum Length: 25
    Number that identifies the document that the supplier created for the purchase order.
  • Title: Supplier Order Line
    Read Only: true
    Maximum Length: 25
    Number or text that the supplier uses to identify a purchase order schedule.
  • Title: Tax Classification
    Read Only: true
    Maximum Length: 255
    Grouping of taxes for reporting and processing purposes.
  • Title: Tax Classification Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the tax classification.
  • Title: Total
    Read Only: true
    Ordered amount plus the exclusive tax amounts of the purchase order schedule.
  • Title: Total Tax
    Read Only: true
    Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order.
  • Title: Transaction Business Category
    Read Only: true
    Maximum Length: 1996
    Classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Title: Transaction Business Category
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Read Only: true
    Value that uniquely identifies the classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    Type of payment released based on units of work or a lump sum amount.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the schedule type.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Unit of measure in the item quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
  • Title: User-Defined Fiscal Classification
    Read Only: true
    Maximum Length: 240
    Additional classification of the transaction for tax purposes.
  • Title: User-Defined Fiscal Classification
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the user-defined fiscal classification.
  • Read Only: true
    Value that uniquely identifies the work order in the factory.
  • Title: Work Order
    Read Only: true
    Maximum Length: 120
    Display number that uniquely identifies the work order in the factory.
  • Title: Operation Sequence
    Read Only: true
    Sequence to use when performing each work order operation.
Nested Schema : Attachments for Schedules
Type: array
Title: Attachments for Schedules
The Attachments for Schedules resource manage attachments for a purchase order schedule.
Show Source
Nested Schema : Flexfields for Schedules
Type: array
Title: Flexfields for Schedules
The Flexfields for Schedules resource manages additional details about purchase order schedules.
Show Source
Nested Schema : Distributions
Type: array
Title: Distributions
The Distributions resource manages purchasing details, such as details about accounting or the project.
Show Source
Nested Schema : US Federal Attributes for Schedules
Type: array
Title: US Federal Attributes for Schedules
The US Federal Attributes for Schedules resource manages federal financial attributes for purchase order schedules.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSPOLineLocations":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poScheduleGdf_view_PoScheduleGDFFVxUSPOLineLocationsVO-item-response" } }
Nested Schema : purchaseOrders-lines-schedules-attachments-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-schedules-DFF-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-schedules-distributions-item-response
Type: object
Show Source
Nested Schema : Flexfields for Distributions
Type: array
Title: Flexfields for Distributions
The Flexfields for Distributions resource manages additional details about purchase order distributions.
Show Source
Nested Schema : US Federal Attributes for Distributions
Type: array
Title: US Federal Attributes for Distributions
The US Federal Attributes for Distributions resource manages federal financial attributes for purchase order distributions.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poDistributionGdf_view_PoDistributionGDFFVxUSPODistributionsVO-item-response" } }
Nested Schema : Project Costing Flexfields for Distributions
Type: array
Title: Project Costing Flexfields for Distributions
The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : purchaseOrders-lines-schedules-distributions-DFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poDistributionGdf_view_PoDistributionGDFFVxUSPODistributionsVO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poScheduleGdf_view_PoScheduleGDFFVxUSPOLineLocationsVO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poLineSHdf_view_POLineSHORA__5FPO__5FBILL__5FONLY__5FLINESVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poHeaderSHdf_view_POHeaderSHORA__5FPO__5FBILL__5FONLY__5FHEADERSVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Back to Top

Examples

This example describes different ways to get all purchase orders.

Get All Purchase Orders

Use the following cURL command to submit a get request on the REST resource.

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrders"

Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "POHeaderId": 100000019476400,
            "OrderNumber": "1000112",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "CreationDate": "2009-07-27T11:40:15.292+00:00",
            "StatusCode": "INCOMPLETE",
            "Status": "Incomplete",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": null,
            "BuyerId": 25,
            "Buyer": "Smith, Pat",
            "SupplierId": 1178,
            "Supplier": "CDS, Inc",
            "SupplierSiteId": 2854,
            "SupplierSite": "PITTSBURGH",
            "SupplierContactId": 2061,
            "SupplierContact": "Brown, John",
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": "Corporate",
            "Ordered": 8000,
            "CurrencyCode": "AUD",
            "Currency": "Australian Dollar",
            "TotalTax": 0,
            "Total": 8000,
            "Description": null,
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10014,
            "PaymentTerms": "2/10 NET 30",
            "CarrierId": 12519,
            "Carrier": "Airborne",
            "ModeOfTransportCode": "PARCEL",
            "ModeOfTransport": "Parcel",
            "ServiceLevelCode": "2DA",
            "ServiceLevel": "2nd day air",
            "ShippingMethod": "Airborne-Parcel-2nd day air",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Origin",
            "FOB": "Origin",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": true,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },
        {
            "POHeaderId": 422092,
            "OrderNumber": "1000114",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "CreationDate": "2009-07-02T11:28:33.193+00:00",
            "StatusCode": "ON HOLD",
            "Status": "On Hold",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": 0,
            "BuyerId": 100010026863775,
            "Buyer": "Mancia, Matthew",
            "SupplierId": 1220,
            "Supplier": "CV_SuppC00",
            "SupplierSiteId": 1220,
            "SupplierSite": "CVSuppC00Site01",
            "SupplierContactId": null,
            "SupplierContact": null,
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": null,
            "Ordered": 199,
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "TotalTax": 0,
            "Total": 199,
            "Description": "CVPO0005",
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10003,
            "PaymentTerms": "45 Net (terms date + 45)",
            "CarrierId": 12519,
            "Carrier": "Airborne",
            "ModeOfTransportCode": "PARCEL",
            "ModeOfTransport": "Parcel",
            "ServiceLevelCode": "2DA",
            "ServiceLevel": "2nd day air",
            "ShippingMethod": "Airborne-Parcel-2nd day air",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Origin",
            "FOB": "Origin",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": true,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },{
        ...
        }
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrders",
            "name": "purchaseOrders",
            "kind": "collection"
        }
    ]
}

Get All Purchase Orders According to Order Number

In this example, you use a query operator in the following cURL command to get all purchase orders for order number 1000947.

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrders/?q=OrderNumber=1000947"

Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "POHeaderId": 100000019476400,
            "OrderNumber": "1000947",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "CreationDate": "2009-07-27T11:40:15.292+00:00",
            "StatusCode": "INCOMPLETE",
            "Status": "Incomplete",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": null,
            "BuyerId": 25,
            "Buyer": "Smith, Pat",
            "SupplierId": 1178,
            "Supplier": "CDS, Inc",
            "SupplierSiteId": 2854,
            "SupplierSite": "PITTSBURGH",
            "SupplierContactId": 2061,
            "SupplierContact": "Brown, John",
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": "Corporate",
            "Ordered": 8000,
            "CurrencyCode": "AUD",
            "Currency": "Australian Dollar",
            "TotalTax": 0,
            "Total": 8000,
            "Description": null,
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10014,
            "PaymentTerms": "2/10 NET 30",
            "CarrierId": 12519,
            "Carrier": "Airborne",
            "ModeOfTransportCode": "PARCEL",
            "ModeOfTransport": "Parcel",
            "ServiceLevelCode": "2DA",
            "ServiceLevel": "2nd day air",
            "ShippingMethod": "Airborne-Parcel-2nd day air",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Origin",
            "FOB": "Origin",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": false,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },
        {
            "POHeaderId": 422092,
            "OrderNumber": "1000947",
            "SoldToLegalEntityId": 206,
            "SoldToLegalEntity": "Vision City Operations",
            "CreationDate": "2009-07-02T11:28:33.193+00:00",
            "StatusCode": "ON HOLD",
            "Status": "On Hold",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": 0,
            "BuyerId": 100010026863775,
            "Buyer": "Mancia, Matthew",
            "SupplierId": 1220,
            "Supplier": "CV_SuppC00",
            "SupplierSiteId": 1220,
            "SupplierSite": "CVSuppC00Site01",
            "SupplierContactId": null,
            "SupplierContact": null,
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": null,
            "Ordered": 199,
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "TotalTax": 0,
            "Total": 199,
            "Description": "CVPO0005",
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10003,
            "PaymentTerms": "45 Net (terms date + 45)",
            "CarrierId": 12519,
            "Carrier": "Airborne",
            "ModeOfTransportCode": "PARCEL",
            "ModeOfTransport": "Parcel",
            "ServiceLevelCode": "2DA",
            "ServiceLevel": "2nd day air",
            "ShippingMethod": "Airborne-Parcel-2nd day air",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Origin",
            "FOB": "Origin",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": true,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/422092/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },{
        ...
        }

    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrders",
            "name": "purchaseOrders",
            "kind": "collection"
        }
    ]
}

Get All Purchase Orders According to the Sold-to Legal Entity

In this example, you use the following cURL command to get purchase orders where the Sold To Legal Entity is Vision Operations.

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrders/?q=SoldToLegalEntity='Vision+Operations'"

Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "POHeaderId": 100000019476400,
            "OrderNumber": "1000947",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "CreationDate": "2009-07-27T11:40:15.292+00:00",
            "StatusCode": "INCOMPLETE",
            "Status": "Incomplete",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": null,
            "BuyerId": 25,
            "Buyer": "Smith, Pat",
            "SupplierId": 1178,
            "Supplier": "CDS, Inc",
            "SupplierSiteId": 2854,
            "SupplierSite": "PITTSBURGH",
            "SupplierContactId": 2061,
            "SupplierContact": "Brown, John",
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": "Corporate",
            "Ordered": 8000,
            "CurrencyCode": "AUD",
            "Currency": "Australian Dollar",
            "TotalTax": 0,
            "Total": 8000,
            "Description": null,
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10014,
            "PaymentTerms": "2/10 NET 30",
            "CarrierId": 12519,
            "Carrier": "Airborne",
            "ModeOfTransportCode": "PARCEL",
            "ModeOfTransport": "Parcel",
            "ServiceLevelCode": "2DA",
            "ServiceLevel": "2nd day air",
            "ShippingMethod": "Airborne-Parcel-2nd day air",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Origin",
            "FOB": "Origin",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": true,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/100000019476400/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },
        {
            "POHeaderId": 421786,
            "OrderNumber": "1000725",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "CreationDate": "2010-04-30T04:27:51.773+00:00",
            "StatusCode": "OPEN",
            "Status": "Open",
            "ProcurementBUId": 204,
            "ProcurementBU": "Vision Operations",
            "RequisitioningBUId": 204,
            "RequisitioningBU": "Vision Operations",
            "BillToBUId": 204,
            "BillToBU": "Vision Operations",
            "Revision": 0,
            "BuyerId": 100010024202242,
            "Buyer": "Johnson, Andrew",
            "SupplierId": 495,
            "Supplier": "Office Depot, Inc",
            "SupplierSiteId": 2524,
            "SupplierSite": "84",
            "SupplierContactId": null,
            "SupplierContact": null,
            "BillToLocationId": 204,
            "BillToLocation": "V1- New York City",
            "ConversionRateType": null,
            "Ordered": 1990,
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "TotalTax": 0,
            "Total": 1990,
            "Description": "zBIA_May_03",
            "RequiredAcknowledgmentCode": "N",
            "RequiredAcknowledgment": "None",
            "SupplierOrder": null,
            "ReferenceNumber": null,
            "AcknowledgmentDueDate": null,
            "PaymentTermsId": 10045,
            "PaymentTerms": "1/10 NET 30",
            "CarrierId": null,
            "Carrier": null,
            "ModeOfTransportCode": null,
            "ModeOfTransport": null,
            "ServiceLevelCode": null,
            "ServiceLevel": null,
            "ShippingMethod": "",
            "FreightTermsCode": "Due",
            "FreightTerms": "Due",
            "FOBCode": "Destination",
            "FOB": "Destination",
            "RequiresSignatureFlag": false,
            "AcknowledgeWithinDays": null,
            "BuyerManagedTransportFlag": false,
            "PayOnReceiptFlag": true,
            "ConfirmingOrderFlag": false,
            "NoteToSupplier": null,
            "NoteToReceiver": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/421786",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/421786",
                    "name": "purchaseOrders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/purchaseOrders/421786/child/lines",
                    "name": "lines",
                    "kind": "collection"
                }
            ]
        },{
        ...
        }  
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrders",
            "name": "purchaseOrders",
            "kind": "collection"
        }
    ]
}
Back to Top