Get all purchase orders
/fscmRestApi/resources/11.13.18.05/purchaseOrders
Request
-
effectiveDate: string
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
-
expand: string
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).
-
fields: string
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 -
finder: string
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, and LOBUser.
- SysEffectiveDate; object.
- PrimaryKey: Finds a purchase order according to the purchase order identifier.
-
limit: integer
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.
-
links: string
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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.
- 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.
- 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.
- 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 is financially responsible for purchases on the purchase order.
- 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.
- 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.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
- application/json
Default Response
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
array
Links
object
-
AcknowledgeWithinDays: number
Title:
Acknowledge Within Days
Read Only:true
Number of days the supplier can decide to accept or reject the purchase order. -
AcknowledgmentDueDate: string
(date)
Title:
Acknowledgment Due Date
Read Only:true
Date that the application requests the supplier to acknowledge the purchase order. -
AdditionalContactEmail: string
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: array
Attachments for Purchase Orders
Title:
Attachments for Purchase Orders
The Attachments for Purchase Orders resource manage attachments for a purchase order. -
BillToBU: string
Title:
Bill-to BU
Read Only:true
Maximum Length:240
Business unit that processes supplier invoices for the purchase order. -
BillToBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that processes supplier invoices for the purchase order. -
BillToLocation: string
Title:
Bill-to Location
Bill-to location where the supplier must send the invoice. -
BillToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the bill-to location. -
Buyer: string
Title:
Buyer
Read Only:true
Maximum Length:240
Person who is responsible for managing the purchase order. -
BuyerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the buyer. -
BuyerManagedTransportFlag: boolean
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. -
Carrier: string
Title:
Carrier
Read Only:true
Maximum Length:360
Company that transports the item through land, sea, or air. -
CarrierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the company that transports the item through land, sea, or air. -
ConfirmingOrderFlag: boolean
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 is not aware of the purchase order. -
ConversionRateType: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the buyer or application creates the purchase order. -
CreditAmount: number
Title:
Credit
Read Only:true
Total of the amounts from the purchase order lines with a credit line type. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Purchase order currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the purchase order. -
DFF: array
Flexfields for Purchase Orders
Title:
Flexfields for Purchase Orders
The Flexfields for Purchase Orders resource manages additional details about purchase orders. -
DiscountAmount: number
Title:
Discount
Read Only:true
Total of the discount amounts from the purchase order lines. -
FOB: string
Title:
FOB
Read Only:true
Maximum Length:80
Free on board. Location where ownership of the item transfers from the supplier to the buyer. -
FOBCode: string
Title:
FOB
Read Only:true
Maximum Length:30
Abbreviation that identifies the type of term for free on board for the item. -
FreightTerms: string
Title:
Freight Terms
Read Only:true
Maximum Length:80
Terms that describe who pays charges to transport the item. -
FreightTermsCode: string
Title:
Freight Terms
Read Only:true
Maximum Length:30
Abbreviation that identifies the type of freight terms for the purchase order. -
globalDFFs: array
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. -
ImportSourceCode: string
Title:
Import Source
Read Only:true
Maximum Length:25
Value that indicates the source application from which the purchase order was imported. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application most recently updated the purchase order. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the purchase order. -
lines: array
Lines
Title:
Lines
The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterContractId: integer
(int64)
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. -
MasterContractNumber: string
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. -
MasterContractType: string
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. -
MasterContractTypeId: integer
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.
-
ModeOfTransport: string
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. -
ModeOfTransportCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the mode of transport. -
NoteToReceiver: string
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. -
NoteToSupplier: string
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. -
Ordered: number
Title:
Ordered
Read Only:true
Total of the amounts from the purchase order lines. Do not include exclusive taxes. -
OrderedAmountBeforeAdjustments: number
Title:
Ordered Before Adjustments
Read Only:true
Total of the amounts from the purchase order lines. Does not include credits, discounts, or exclusive taxes. -
OrderNumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. -
OverrideB2BCommunicationFlag: boolean
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. -
OverridingApprover: string
Title:
Overriding Approver
Read Only:true
Maximum Length:240
Overriding first approver identifier to route purchase orders for approval. -
OverridingApproverId: integer
(int64)
Read Only:
true
Value that uniquely identifies the user specified on the purchase order as the overriding approver for approval routing. -
PaymentTerms: string
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. -
PaymentTermsId: integer
(int64)
Read Only:
true
Value that uniquely identifies the payment terms. -
PayOnReceiptFlag: boolean
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. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order. -
ProcurementBU: string
Title:
Procurement BU
Read Only:true
Maximum Length:240
Business unit that manages and owns the purchase order. -
ProcurementBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that manages and owns the purchase order. -
ReferenceNumber: string
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. -
RequiredAcknowledgment: string
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. -
RequiredAcknowledgmentCode: string
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. -
RequiresSignatureFlag: boolean
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 requires signatures to meet legal requirements. If false, then the purchase order does not require signatures. -
RequisitioningBU: string
Title:
Requisitioning BU
Read Only:true
Maximum Length:240
Business unit that creates the requisition. -
RequisitioningBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit that creates the requisition. -
Revision: number
Title:
Revision
Read Only:true
Versions of the purchase order that requires communication to and, as an option, get acknowledgment from the supplier. -
ServiceLevel: string
Title:
Service Level
Read Only:true
Maximum Length:80
Priority that determines how quickly to transport the item. -
ServiceLevelCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the service level for the shipping method. -
ShippingMethod: string
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. -
SoldToLegalEntity: string
Title:
Sold-to Legal Entity
Read Only:true
Maximum Length:240
Party who is financially responsible for purchases on the purchase order. -
SoldToLegalEntityId: integer
(int64)
Read Only:
true
Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the purchase order relative to the purchase order life cycle. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:25
Abbreviation that identifies the purchase order status in the order life cycle. -
Supplier: string
Title:
Supplier
Read Only:true
Maximum Length:360
Supplier who fulfills the item. -
SupplierBccEmailAddress: string
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. -
SupplierCcEmailAddress: string
Title:
Cc
Read Only:true
Maximum Length:2000
Email address to which a copy of the purchase order communication email is sent. -
SupplierCommunicationMethod: string
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. -
SupplierContact: string
Title:
Supplier Contact
Read Only:true
Maximum Length:360
Person who represents the supplier when communicating with the buyer. -
SupplierContactId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier contact. -
SupplierEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:2000
Email address of the supplier for communication. -
SupplierFax: string
Title:
Fax
Read Only:true
Maximum Length:60
Fax number used to communicate the purchase order to the supplier. -
SupplierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier. -
SupplierOrder: string
Title:
Supplier Order
Read Only:true
Maximum Length:25
Document number that the supplier created for the purchase order. -
SupplierSite: string
Title:
Supplier Site
Read Only:true
Maximum Length:240
Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Read Only:
true
Value that uniquely identifies the supplier site. -
Total: number
Title:
Total
Read Only:true
Ordered amount plus the exclusive tax amounts for the purchase order. -
TotalTax: number
Title:
Total Tax
Read Only:true
Exclusive tax amount that the purchase can recover and not recover for the purchase order.
array
Attachments for Purchase Orders
array
Flexfields for Purchase Orders
array
US Federal Attributes for Purchase Orders
array
Lines
array
Links
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attached document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attached document. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attached document.
array
Links
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
__FLEX_Context: string
Title:
Context Prompt
Read Only:true
Maximum Length:30
Descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order.
array
Links
object
-
__FLEX_Context: string
Title:
Context Segment
Read Only:true
Maximum Length:150
Global descriptive flexfield context name for US federal attributes in a purchase order distribution. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Global descriptive flexfield context display value for US federal attributes in a purchase order distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order.
array
Links
object
-
attachments: array
Attachments for Lines
Title:
Attachments for Lines
The Attachments for Lines resource manage attachments for a purchase order line. -
BasePrice: number
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. -
Category: string
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. -
CategoryCode: string
Read Only:
true
Maximum Length:820
Abbreviation that identifies the purchasing category. -
CategoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchasing category. -
ConsignmentLineFlag: boolean
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 is not under consignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase order line. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase order line. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Purchase order currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the item that the purchase order references. -
DFF: array
Flexfields for Lines
Title:
Flexfields for Lines
The Flexfields for Lines resource manages additional details about purchase order lines. -
Discount: number
Title:
Discount
Read Only:true
Value that indicates the discount percent or amount of the purchase order line. -
DiscountReason: string
Title:
Discount Reason
Read Only:true
Maximum Length:240
Reason for the discount. -
DiscountType: string
Title:
Meaning
Read Only:true
Maximum Length:80
Type of discount that indicates whether the discount is based on amount or percent. -
HazardClass: string
Title:
Hazard Class
Read Only:true
Maximum Length:40
Name of the hazard class that is used to identify and classify hazardous materials to comply with the safety regulations. -
HazardClassCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the hazard class. -
HazardClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the hazard class. -
Item: string
Title:
Item
Read Only:true
Abbreviation that uniquely identifies the item on the purchase order. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the item on the purchase order. -
ItemRevision: string
Title:
Item Revision
Read Only:true
Maximum Length:18
Revision number of the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application most recently updated the purchase order line. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the purchase order line. -
LineNumber: number
Title:
Line
Read Only:true
Number that uniquely identifies the purchase order line. -
LineType: string
Title:
Line Type
Read Only:true
Maximum Length:30
Type that indicates whether the purchase order line references an item or a service. -
LineTypeId: integer
(int64)
Read Only:
true
Value that uniquely identifies whether the purchase order line references an item or a service. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Manufacturer: string
Title:
Manufacturer
Read Only:true
Maximum Length:700
Name of the manufacturer of the item. -
ManufacturerPartNumber: string
Title:
Manufacturer Part Number
Read Only:true
Maximum Length:700
Number issued by the manufacturer that uniquely identifies the individual product. -
MaximumRetainageAmount: number
Title:
Maximum Retainage Amount
Read Only:true
Maximum amount of retainage that can be withheld on a contract line. -
NegotiatedFlag: boolean
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. -
NoteToSupplier: string
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. -
Ordered: number
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. -
OrderNumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line. -
Price: number
Title:
Price
Read Only:true
Price of the purchase order line. -
PricingUOM: string
Title:
Pricing UOM
Read Only:true
Maximum Length:25
Unit of measure that the item uses for pricing. -
PricingUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure the item uses for pricing. -
Quantity: number
Title:
Quantity
Read Only:true
Quantity of the item on the order line. -
schedules: array
Schedules
Title:
Schedules
The Schedules resource manages purchasing details, such as ship-to location and delivery date. -
SecondaryQuantity: string
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. -
SecondaryUOM: string
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. -
SecondaryUOMCode: string
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. -
SourceAgreementId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source agreement that the purchase order line references. -
SourceAgreementLine: number
Title:
Source Agreement Line
Read Only:true
Number that uniquely identifies the source agreement line that the purchase order line references. -
SourceAgreementLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the source agreement line that the purchase order line references. -
SourceAgreementNumber: string
Title:
Source Agreement
Read Only:true
Maximum Length:30
Number that uniquely identifies the source agreement that the purchase order line references. -
SourceAgreementProcurementBU: string
Title:
Source Agreement Procurement BU
Business unit of the purchase agreement against which this purchase order line is released. -
SourceAgreementProcurementBUId: integer
(int64)
Read Only:
true
Value that uniquely identifies the business unit of the purchase agreement against which this purchase order line is released. -
SourceAgreementType: string
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. -
SourceAgreementTypeCode: string
Read Only:
true
Maximum Length:25
Source agreement type. For example, CONTRACT or BLANKET. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the purchase order line. -
StatusCode: string
Title:
Line Status
Read Only:true
Maximum Length:25
Abbreviation that identifies the status of the purchase order line. -
SupplierConfigurationId: string
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. -
SupplierItem: string
Title:
Supplier Item
Read Only:true
Maximum Length:300
Number that the supplier uses to identify the item on the purchase order line. -
Total: number
Title:
Total
Read Only:true
Ordered amount plus the exclusive tax amounts on the purchase order line. -
TotalTax: number
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. -
UNNumber: string
Title:
UN Number
Read Only:true
Maximum Length:20
Number that the United Nations uses to identify hazardous material. -
UNNumberDescription: string
Title:
UN Number Description
Read Only:true
Maximum Length:240
Description of the hazardous material that the United Nations identification number references. -
UNNumberId: integer
(int64)
Read Only:
true
Value that uniquely identifies the number that the United Nations uses to identify hazardous material. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Unit of measure that the item uses for the quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure. -
WorkOrderProduct: string
Title:
Product
Read Only:true
Maximum Length:300
Finished item that the work order in contract manufacturing creates.
array
Attachments for Lines
array
Flexfields for Lines
array
Links
array
Schedules
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attached document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attached document. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attached document.
array
Links
object
-
__FLEX_Context: string
Title:
Context Prompt
Read Only:true
Maximum Length:30
Descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order line.
array
Links
object
-
AccrueAtReceiptFlag: boolean
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 do not accrue at receipt. -
AllowSubstituteReceiptsFlag: boolean
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. -
attachments: array
Attachments for Schedules
Title:
Attachments for Schedules
The Attachments for Schedules resource manage attachments for a purchase order schedule. -
BackToBackFlag: boolean
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. -
BilledAmount: number
Title:
Invoice Matched
Read Only:true
Amount equivalent of the matched invoice lines based on the purchase price. -
BilledQuantity: number
Title:
Invoiced Quantity
Read Only:true
Quantity invoiced against the purchase order schedule. -
Carrier: string
Title:
Carrier
Read Only:true
Maximum Length:360
Company that transports the item. -
CarrierId: integer
(int64)
Read Only:
true
Value that uniquely identifies the company that transports the item. -
CountryOfOrigin: string
Title:
Country of Origin
Read Only:true
Maximum Length:80
Country where the organization that ships and exports the item resides. -
CountryOfOriginCode: string
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. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase order schedule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the buyer or application created the purchase order schedule. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Purchase order currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work associated with the progress payment schedule. -
DestinationType: string
Title:
Destination Type
Read Only:true
Maximum Length:80
Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order. -
DestinationTypeCode: string
Title:
Destination Type
Read Only:true
Maximum Length:25
How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING. -
DFF: array
Flexfields for Schedules
Title:
Flexfields for Schedules
The Flexfields for Schedules resource manages additional details about purchase order schedules. -
distributions: array
Distributions
Title:
Distributions
The Distributions resource manages purchasing details, such as details about accounting or the project. -
EarlyReceiptToleranceDays: number
Title:
Early Receipt Tolerance in Days
Read Only:true
Maximum number of days the application allows to receive an early shipment. -
globalDFFs: array
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. -
InvoiceCloseTolerancePercent: number
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. -
InvoiceMatchOption: string
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. -
InvoiceMatchOptionCode: string
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. -
LastAcceptableDeliveryDate: string
(date)
Title:
Last Acceptable Delivery Date
Read Only:true
Last date when the shipper can deliver the item. -
LastAcceptableShipDate: string
(date)
Title:
Last Acceptable Ship Date
Read Only:true
Last date when the shipper can ship the item. -
LastAcceptDate: string
(date)
Read Only:
true
Last date when the receiver can receive the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application most recently updated the purchase order schedule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the purchase order schedule. -
LateReceiptToleranceDays: number
Title:
Late Receipt Tolerance in Days
Read Only:true
Maximum number of days the application allows to receive a late shipment. -
LineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
LineNumber: number
Title:
Line
Read Only:true
Number that uniquely identifies the purchase order line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatchApprovalLevelCode: string
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. -
ModeOfTransport: string
Title:
Mode of Transport
Read Only:true
Maximum Length:80
Mode of transportation that ships the item, such as truck, air, or boat. -
ModeOfTransportCode: string
Title:
Mode of Transport
Read Only:true
Maximum Length:30
Abbreviation that identifies the mode of transport. -
NoteToReceiver: string
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. -
OrchestrationAgreementLineNumber: integer
(int64)
Read Only:
true
Number that identifies the orchestration agreement line. -
OrchestrationAgreementNumber: string
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. -
Ordered: number
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. -
OrderNumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. -
OriginalPromisedDeliveryDate: string
(date)
Title:
Original Promised Delivery Date
Read Only:true
Date when the supplier promises to deliver the item that the buyer ordered. -
OriginalPromisedShipDate: string
(date)
Title:
Original Promised Ship Date
Read Only:true
Date when the supplier promises to ship the item that the buyer ordered. -
OverReceiptAction: string
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. -
OverReceiptActionCode: string
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. -
OverReceiptTolerancePercent: number
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. -
POHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order. -
POLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the parent of the purchase order line. -
POTradingOrganization: string
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. -
POTradingOrganizationCode: string
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. -
POTradingOrganizationId: integer
(int64)
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. -
Price: number
Title:
Price
Read Only:true
Price of the purchase order line. -
PricingUOM: string
Title:
Pricing UOM
Read Only:true
Maximum Length:25
Abbreviation that identifies the unit of measure the item uses for pricing. -
PricingUOMCode: string
Read Only:
true
Maximum Length:3
Unit of measure that the item uses for pricing. -
PrimaryTradeRelationshipId: integer
(int64)
Read Only:
true
Value that uniquely identifies the primary trade relationship in an orchestration agreement. -
PromisedDeliveryDate: string
(date)
Title:
Promised Delivery Date
Read Only:true
Date when the supplier promises to deliver the item to the buyer. -
PromisedShipDate: string
(date)
Title:
Promised Ship Date
Read Only:true
Date when the supplier promises to ship the item to the buyer. -
Quantity: number
Title:
Quantity
Read Only:true
Scheduled quantity of the item. -
ReceiptCloseTolerancePercent: number
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. -
ReceiptDateExceptionAction: string
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. -
ReceiptDateExceptionActionCode: string
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. -
ReceiptRouting: string
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. -
ReceiptRoutingId: integer
(int64)
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. -
ReceivedAmount: number
Title:
Received
Read Only:true
Amount received for service lines. -
ReceivedQuantity: number
Title:
Received Quantity
Read Only:true
Quantity received against the purchase order schedule. -
RequestedDeliveryDate: string
(date)
Title:
Requested Delivery Date
Read Only:true
Date when the buyer requests that the supplier deliver the item. -
RequestedShipDate: string
(date)
Title:
Requested Ship Date
Read Only:true
Date when the buyer requests that the supplier ship the item. -
RetainageAmount: number
Title:
Retainage
Read Only:true
Total amount withheld as retainage against the schedule. -
RetainageRate: number
Title:
Retainage Rate
Read Only:true
Percentage of the invoice value that can be withheld as retainage. -
RetainageReleasedAmount: number
Title:
Retainage Released
Read Only:true
Amount of retainage released for the schedule. -
SalesOrderNumber: string
Title:
Customer Sales Order
Read Only:true
Maximum Length:50
Number that uniquely identifies the sales order that the purchase order schedule references. -
ScheduleNumber: number
Title:
Schedule
Read Only:true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
SecondaryQuantity: number
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. -
SecondaryUOM: string
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. -
SecondaryUOMCode: string
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. -
ShipToCustomer: string
Title:
Ship-to Party
Read Only:true
Maximum Length:360
Name of the party who receives the item that the supplier ships. -
ShipToCustomerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the third party that receives the item. -
ShipToExceptionAction: string
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. -
ShipToExceptionActionCode: string
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. -
ShipToLocationCode: string
Title:
Location
Read Only:true
Maximum Length:60
Abbreviation that identifies the location where the supplier ships the item. -
ShipToLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location where the supplier ships the item. -
ShipToOrganization: string
Title:
Ship-to Organization
Read Only:true
Maximum Length:240
Name of the inventory organization that receives the item. -
ShipToOrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the inventory organization where the supplier ships the item. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization where the supplier ships the item. -
Status: string
Title:
Status
Read Only:true
Maximum Length:80
Status of the purchase order schedule. -
StatusCode: string
Title:
Status
Read Only:true
Maximum Length:25
Abbreviation that identifies the status of the purchase order schedule. -
Total: number
Title:
Total
Read Only:true
Ordered amount plus the exclusive tax amounts of the purchase order schedule. -
TotalTax: number
Title:
Total Tax
Read Only:true
Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order. -
Type: string
Title:
Type
Read Only:true
Maximum Length:80
Type of payment whether it is released based on units of work or lump sum. -
TypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the schedule type. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Unit of measure in the item quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order in the factory. -
WorkOrderNumber: string
Title:
Work Order
Read Only:true
Maximum Length:120
Display number that uniquely identifies the work order in the factory. -
WorkOrderOperationSequence: number
Title:
Operation Sequence
Read Only:true
Sequence to use when performing each work order operation.
array
Attachments for Schedules
array
Flexfields for Schedules
array
Distributions
array
US Federal Attributes for Schedules
array
Links
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the document that is attached to the purchase order. It is a primary key that the application creates when the user attaches a document to the purchase order. -
CategoryName: string
Title:
Category
Maximum Length:30
Category of the attached document. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attached document. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the document that is attached to the purchase order. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attached document. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attached document. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attached document. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the version of the attached document. -
DownloadInfo: string
Title:
DownloadInfo
JSON-formatted string that contains information required to programmatically retrieve a large file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attached document. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attached document. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the content in the attached document expires. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached document. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attached document. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attached document. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that is attached to the purchase order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the document that is attached to the purchase order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that is attached to the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
Name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attached document. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attached document. -
UploadedFileLength: integer
Title:
File Size
Length of the attached document. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached document. -
UploadedText: string
Title:
Uploaded Text
Text of the attached document. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
Url: string
Title:
Url
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attached document. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attached document.
array
Links
object
-
__FLEX_Context: string
Title:
Context Prompt
Read Only:true
Maximum Length:30
Descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Descriptive flexfield context display value for purchase order distributions. -
LineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
object
-
BudgetDate: string
(date)
Title:
Budget Date
Date to use to determine the timeframe when the organization consumed the budget. -
ConversionRate: number
Title:
Conversion Rate
Conversion rate to use when converting the currency. -
ConversionRateDate: string
(date)
Title:
Conversion Date
Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the purchase order distribution. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application created the purchase order distribution. -
Currency: string
Title:
Currency
Read Only:true
Maximum Length:80
Purchase order currency. -
CurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the purchase order currency. -
DeliverToCustomer: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the third-party that receives the item. -
DeliverToCustomerId: integer
(int64)
Value that uniquely identifies the third-party location that receives the item.
-
DeliverToCustomerLocation: string
Read Only:
true
Name of the customer location that receives the item. Applies during a drop ship. -
DeliverToCustomerLocationId: integer
(int64)
Value that uniquely identifies the third-party location that receives the item.
-
DeliverToLocationCode: string
Title:
Deliver-to Location
Read Only:true
Abbreviation that identifies the final location that receives the item. -
DeliverToLocationId: integer
(int64)
Value that uniquely identifies the final location that receives the item.
-
DestinationChargeAccount: string
Title:
Destination Charge Account
Read Only:true
Account to charge for the cost of the item in the requisitioning business unit. -
DestinationChargeAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the cost of the item in the requisitioning business unit.
-
DestinationSubinventory: string
Title:
Destination Subinventory
Maximum Length:10
Subinventory that identifies where to deliver the requested item. -
DestinationVarianceAccount: string
Title:
Destination Variance Account
Read Only:true
Account to charge for the variation in the purchase price for the purchase in the requisitioning business unit. Applies when the legal entity of the requisitioning business unit is not the same as the sold-to legal entity. -
DestinationVarianceAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the variation in the purchase price for the purchase in the requisitioning business unit. Applies when the legal entity of the requisitioning business unit is not the same as the sold-to legal entity.
-
DFF: array
Flexfields for Distributions
Title:
Flexfields for Distributions
The Flexfields for Distributions resource manages additional details about purchase order distributions. -
DistributionNumber: number
Title:
Distribution
Number that uniquely identifies the purchase order distribution for the purchase order schedule. -
globalDFFs: array
US Federal Attributes for Distributions
Title:
US Federal Attributes for Distributions
The US Federal Attributes for Distributions resource manages federal financial attributes for purchase order distributions. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the buyer or application most recently updated the purchase order distribution. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the purchase order distribution. -
LineNumber: number
Title:
Line
Read Only:true
Number that uniquely identifies the purchase order line for the purchase order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NonrecoverableExclusiveTax: number
Title:
Nonrecoverable Exclusive Tax
Tax that the purchase order amount does not contain. The purchaser cannot recover this tax. -
NonrecoverableInclusiveTax: number
Title:
Nonrecoverable Inclusive Tax
Tax that the purchase order amount contains. The purchaser cannot recover this tax. -
Ordered: number
Title:
Ordered
Price multiplied by the distribution quantity. Applies 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 distribution amount contains. -
OrderNumber: string
Title:
Order
Read Only:true
Maximum Length:30
Number that uniquely identifies the purchase order in the sold-to legal entity. -
POAccrualAccount: string
Title:
PO Accrual Account
Read Only:true
Account to charge for receipt accrual. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same. -
POAccrualAccountId: integer
(int64)
Value that uniquely identifies the account to charge for receipt accrual. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same.
-
POChargeAccount: string
Title:
PO Charge Account
Read Only:true
Account to charge for the purchase. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same. -
POChargeAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the purchase. Applies when the legal entity of the requisitioning business unit and the sold-to legal entity are the same.
-
PODistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
-
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order.
-
POLineId: integer
(int64)
Value that uniquely identifies the parent of the purchase order line.
-
POVarianceAccount: string
Title:
PO Variance Account
Read Only:true
Account to charge for any price difference between the invoice and the purchase order. -
POVarianceAccountId: integer
(int64)
Value that uniquely identifies the account to charge for the price difference between the invoice and the purchase order.
-
projectDFF: array
Project Costing Flexfields for Distributions
Title:
Project Costing Flexfields for Distributions
The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions. -
Quantity: number
Title:
Quantity
Distribution quantity of the item that the purchaser is purchasing. -
RecoverableExclusiveTax: number
Title:
Recoverable Exclusive Tax
Tax that the purchase order amount does not contain. The purchaser can recover this tax. -
RecoverableInclusiveTax: number
Title:
Recoverable Inclusive Tax
Tax that the purchase order amount contains. The purchaser can recover this tax. -
Requester: string
Title:
Requester
Read Only:true
Maximum Length:240
Name of the deliver-to person or requester. -
RequesterId: integer
(int64)
Value that uniquely identifies the deliver-to person or requester.
-
Requisition: string
Title:
Requisition
Read Only:true
Maximum Length:64
Number that identifies the requisition. -
RequisitionDistribution: number
Title:
Requisition Distribution
Read Only:true
Number that uniquely identifies a requisition distribution for the requisition line. -
RequisitionDistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition distribution. -
RequisitionHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition header. -
RequisitionLine: number
Title:
Requisition Line
Read Only:true
Number that uniquely identifies the requisition line for the requisition. -
RequisitionLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the requisition line. -
ScheduleNumber: number
Title:
Schedule
Read Only:true
Number that uniquely identifies the purchase order schedule for the purchase order line. -
Total: number
Title:
Total
Ordered amount plus the exclusive tax amounts of the purchase order distribution. -
TotalTax: number
Title:
Total Tax
Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order distribution. -
UOM: string
Title:
UOM
Read Only:true
Maximum Length:25
Unit of measure of the item quantity. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure.
array
Flexfields for Distributions
array
US Federal Attributes for Distributions
array
Links
array
Project Costing Flexfields for Distributions
object
-
__FLEX_Context: string
Title:
Context Prompt
Maximum Length:30
Descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Prompt
Descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
array
Links
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
Global descriptive flexfield context name for US federal attributes in a purchase order distribution. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Global descriptive flexfield context display value for US federal attributes in a purchase order distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
array
Links
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:40
Project costing descriptive flexfield context name for purchase order distributions. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
Project costing descriptive flexfield context display value for purchase order distributions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PoDistributionId: integer
(int64)
Value that uniquely identifies the purchase order distribution.
array
Links
object
-
__FLEX_Context: string
Title:
Context Segment
Read Only:true
Maximum Length:150
Global descriptive flexfield context name for US federal attributes in a purchase order distribution. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Global descriptive flexfield context display value for US federal attributes in a purchase order distribution. -
LineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the purchase order schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
array
Links
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" } ] }