Jump to

• Request
• Response
• Examples

Get all purchase orders

get

/fscmRestApi/resources/11.13.18.05/purchaseOrders

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • 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.
  • PrimaryKey: Finds a purchase order according to the purchase order identifier. Finder Variables:
    • POHeaderId; integer; Value that uniquely identifies a purchase order.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : purchaseOrders

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "type":"object",
    "properties":{
        "count":{
            "title":"Count",
            "description":"The number of resource instances returned in the current range.",
            "type":"integer"
        },
        "hasMore":{
            "title":"HasMore",
            "description":"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.",
            "type":"boolean"
        },
        "items":{
            "title":"Items",
            "description":"The items in the collection.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-item"
            }
        },
        "limit":{
            "title":"Limit",
            "description":"The actual paging size used by the server.",
            "type":"integer"
        },
        "links":{
            "title":"Items",
            "description":"The link relations associated with the resource instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "offset":{
            "title":"Offset",
            "description":"The offset value used in the current page.",
            "type":"integer"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseOrders-item

{
    "title":"Items",
    "description":"The items in the collection.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"The link relations associated with the resource instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-item

Type: object

Show Source

• AcknowledgeWithinDays(optional): number
  Title: Acknowledge Within Days

  Number of days the supplier can decide to accept or reject the purchase order.
• AcknowledgmentDueDate(optional): string(date)
  Title: Acknowledgment Due Date

  Date that the application requests the supplier to acknowledge the purchase order.
• attachments(optional): array Attachments for Purchase Orders
  Title: Attachments for Purchase Orders

  The Attachments for Purchase Orders resource manage attachments for a purchase order.
• BillToBU(optional): string
  Title: Bill-to BU

  Maximum Length: 240

  Business unit that processes supplier invoices for the purchase order.
• BillToBUId(optional): integer(int64)
  Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.
• BillToLocation(optional): string
  Title: Bill-to Location

  Bill-to location where the supplier must send the invoice.
• BillToLocationId(optional): integer(int64)
  Value that uniquely identifies the bill-to location.
• Buyer(optional): string
  Title: Buyer

  Maximum Length: 240

  Person who is responsible for managing the purchase order.
• BuyerId(optional): integer(int64)
  Value that uniquely identifies the buyer.
• BuyerManagedTransportFlag(optional): boolean
  Title: Buyer Managed Transportation

  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(optional): string
  Title: Carrier

  Maximum Length: 360

  Company that transports the item through land, sea, or air.
• CarrierId(optional): integer(int64)
  Value that uniquely identifies the company that transports the item through land, sea, or air.
• ConfirmingOrderFlag(optional): boolean
  Title: Confirming Order

  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(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  Rate type that the application uses to determine the currency conversion rate for the purchase order.
• CreatedBy(optional): string
  Maximum Length: 64

  User who created the purchase order.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  Date and time when the buyer or application creates the purchase order.
• Currency(optional): string
  Title: Currency

  Maximum Length: 80

  Purchase order currency.
• CurrencyCode(optional): string
  Maximum Length: 15

  Abbreviation that identifies the purchase order currency.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  Description of the purchase order.
• DFF(optional): array Flexfields for Purchase Orders
  Title: Flexfields for Purchase Orders

  The Flexfields for Purchase Orders resource manages additional details about purchase orders.
• FOB(optional): string
  Title: FOB

  Maximum Length: 80

  Free on board. Location where ownership of the item transfers from the supplier to the buyer.
• FOBCode(optional): string
  Title: FOB

  Maximum Length: 30

  Abbreviation that identifies the type of term for free on board for the item.
• FreightTerms(optional): string
  Title: Freight Terms

  Maximum Length: 80

  Terms that describe who pays charges to transport the item.
• FreightTermsCode(optional): string
  Title: Freight Terms

  Maximum Length: 30

  Abbreviation that identifies the type of freight terms for the purchase order.
• ImportSourceCode(optional): string
  Title: Import Source

  Maximum Length: 25

  Value that indicates the source application from which the purchase order was imported.
• LastUpdateDate(optional): string(date-time)
  Date and time when the buyer or application most recently updated the purchase order.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  User who most recently updated the purchase order.
• lines(optional): array Lines
  Title: Lines

  The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price.
• links(optional): array Items
  Title: Items

  Link Relations
• MasterContractId(optional): integer(int64)
  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(optional): string
  Title: Master Contract

  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(optional): 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(optional): integer(int64)
  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(optional): string
  Title: Mode of Transport

  Maximum Length: 80

  Mode of transport that the shipper uses to transport the item, such as land, sea, or air.
• ModeOfTransportCode(optional): string
  Maximum Length: 30

  Abbreviation that identifies the mode of transport.
• NoteToReceiver(optional): string
  Title: Note to Receiver

  Maximum Length: 1000

  Note that the receiver can read to get details about how to process the purchase order.
• NoteToSupplier(optional): string
  Title: Note to Supplier

  Maximum Length: 1000

  Note that the supplier can read to get details about how to process the purchase order.
• Ordered(optional): number
  Title: Ordered

  Total of the amounts from the purchase order lines. Do not include exclusive taxes.
• OrderNumber(optional): string
  Title: Order

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• PaymentTerms(optional): string
  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(optional): integer(int64)
  Value that uniquely identifies the payment terms.
• PayOnReceiptFlag(optional): boolean
  Title: Pay on Receipt

  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(optional): integer(int64)
  Value that uniquely identifies the purchase order.
• ProcurementBU(optional): string
  Title: Procurement BU

  Maximum Length: 240

  Business unit that manages and owns the purchase order.
• ProcurementBUId(optional): integer(int64)
  Value that uniquely identifies the business unit that manages and owns the purchase order.
• ReferenceNumber(optional): string
  Title: Reference Number

  Maximum Length: 120

  Document number of the purchase order that the import imported from the legacy application into Oracle Purchasing Cloud.
• RequiredAcknowledgment(optional): string
  Title: Required Acknowledgment

  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(optional): string
  Title: Required Acknowledgment

  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(optional): boolean
  Title: Allow Substitute Receipts

  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(optional): string
  Title: Requisitioning BU

  Maximum Length: 240

  Business unit that creates the requisition.
• RequisitioningBUId(optional): integer(int64)
  Value that uniquely identifies the business unit that creates the requisition.
• Revision(optional): number
  Title: Revision

  Versions of the purchase order that requires communication to and, as an option, get acknowledgment from the supplier.
• ServiceLevel(optional): string
  Title: Service Level

  Maximum Length: 80

  Priority that determines how quickly to transport the item.
• ServiceLevelCode(optional): string
  Maximum Length: 30

  Abbreviation that identifies the service level for the shipping method.
• ShippingMethod(optional): string
  Title: Shipping Method

  Maximum Length: 255

  Transportation method for the carrier or service level for the purchase order. For example, ABC Shipping - AIR - 2nd Day.
• SoldToLegalEntity(optional): string
  Title: Sold-to Legal Entity

  Maximum Length: 240

  Party who is financially responsible for purchases on the purchase order.
• SoldToLegalEntityId(optional): integer(int64)
  Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
• Status(optional): string
  Title: Status

  Maximum Length: 80

  Status of the purchase order relative to the purchase order life cycle.
• StatusCode(optional): string
  Title: Status Code

  Maximum Length: 25

  Abbreviation that identifies the purchase order status in the order life cycle.
• Supplier(optional): string
  Title: Supplier

  Maximum Length: 360

  Supplier who fulfills the item.
• SupplierContact(optional): string
  Title: Supplier Contact

  Maximum Length: 360

  Person who represents the supplier when communicating with the buyer.
• SupplierContactId(optional): integer(int64)
  Value that uniquely identifies the supplier contact.
• SupplierId(optional): integer(int64)
  Value that uniquely identifies the supplier.
• SupplierOrder(optional): string
  Title: Supplier Order

  Maximum Length: 25

  Document number that the supplier created for the purchase order.
• SupplierSite(optional): string
  Title: Supplier Site

  Maximum Length: 15

  Location that the supplier uses to purchase the item.
• SupplierSiteId(optional): integer(int64)
  Value that uniquely identifies the supplier site.
• Total(optional): number
  Title: Total

  Ordered amount plus the exclusive tax amounts for the purchase order.
• TotalTax(optional): number
  Title: Total Tax

  Exclusive tax amount that the purchase can recover and not recover for the purchase order.

{
    "type":"object",
    "properties":{
        "AcknowledgeWithinDays":{
            "title":"Acknowledge Within Days",
            "description":"Number of days the supplier can decide to accept or reject the purchase order.",
            "type":"number"
        },
        "AcknowledgmentDueDate":{
            "title":"Acknowledgment Due Date",
            "description":"Date that the application requests the supplier to acknowledge the purchase order.",
            "type":"string",
            "format":"date"
        },
        "BillToBU":{
            "title":"Bill-to BU",
            "description":"Business unit that processes supplier invoices for the purchase order.",
            "type":"string",
            "maxLength":240
        },
        "BillToBUId":{
            "description":"Value that uniquely identifies the business unit that processes supplier invoices for the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "description":"Bill-to location where the supplier must send the invoice.",
            "type":"string"
        },
        "BillToLocationId":{
            "description":"Value that uniquely identifies the bill-to location.",
            "type":"integer",
            "format":"int64"
        },
        "Buyer":{
            "title":"Buyer",
            "description":"Person who is responsible for managing the purchase order.",
            "type":"string",
            "maxLength":240
        },
        "BuyerId":{
            "description":"Value that uniquely identifies the buyer.",
            "type":"integer",
            "format":"int64"
        },
        "BuyerManagedTransportFlag":{
            "title":"Buyer Managed Transportation",
            "description":"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.",
            "type":"boolean"
        },
        "Carrier":{
            "title":"Carrier",
            "description":"Company that transports the item through land, sea, or air.",
            "type":"string",
            "maxLength":360
        },
        "CarrierId":{
            "description":"Value that uniquely identifies the company that transports the item through land, sea, or air.",
            "type":"integer",
            "format":"int64"
        },
        "ConfirmingOrderFlag":{
            "title":"Confirming Order",
            "description":"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.",
            "type":"boolean"
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "description":"Rate type that the application uses to determine the currency conversion rate for the purchase order.",
            "type":"string",
            "maxLength":30
        },
        "CreatedBy":{
            "description":"User who created the purchase order.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"Date and time when the buyer or application creates the purchase order.",
            "type":"string",
            "format":"date-time"
        },
        "Currency":{
            "title":"Currency",
            "description":"Purchase order currency.",
            "type":"string",
            "maxLength":80
        },
        "CurrencyCode":{
            "description":"Abbreviation that identifies the purchase order currency.",
            "type":"string",
            "maxLength":15
        },
        "DFF":{
            "title":"Flexfields for Purchase Orders",
            "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-DFF-item"
            }
        },
        "Description":{
            "title":"Description",
            "description":"Description of the purchase order.",
            "type":"string",
            "maxLength":240
        },
        "FOB":{
            "title":"FOB",
            "description":"Free on board. Location where ownership of the item transfers from the supplier to the buyer.",
            "type":"string",
            "maxLength":80
        },
        "FOBCode":{
            "title":"FOB",
            "description":"Abbreviation that identifies the type of term for free on board for the item.",
            "type":"string",
            "maxLength":30
        },
        "FreightTerms":{
            "title":"Freight Terms",
            "description":"Terms that describe who pays charges to transport the item.",
            "type":"string",
            "maxLength":80
        },
        "FreightTermsCode":{
            "title":"Freight Terms",
            "description":"Abbreviation that identifies the type of freight terms for the purchase order.",
            "type":"string",
            "maxLength":30
        },
        "ImportSourceCode":{
            "title":"Import Source",
            "description":"Value that indicates the source application from which the purchase order was imported.",
            "type":"string",
            "maxLength":25
        },
        "LastUpdateDate":{
            "description":"Date and time when the buyer or application most recently updated the purchase order.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"User who most recently updated the purchase order.",
            "type":"string",
            "maxLength":64
        },
        "MasterContractId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "MasterContractNumber":{
            "title":"Master Contract",
            "description":"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.",
            "type":"string",
            "maxLength":120
        },
        "MasterContractType":{
            "title":"Master Contract Type",
            "description":"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.",
            "type":"string"
        },
        "MasterContractTypeId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "ModeOfTransport":{
            "title":"Mode of Transport",
            "description":"Mode of transport that the shipper uses to transport the item, such as land, sea, or air.",
            "type":"string",
            "maxLength":80
        },
        "ModeOfTransportCode":{
            "description":"Abbreviation that identifies the mode of transport.",
            "type":"string",
            "maxLength":30
        },
        "NoteToReceiver":{
            "title":"Note to Receiver",
            "description":"Note that the receiver can read to get details about how to process the purchase order.",
            "type":"string",
            "maxLength":1000
        },
        "NoteToSupplier":{
            "title":"Note to Supplier",
            "description":"Note that the supplier can read to get details about how to process the purchase order.",
            "type":"string",
            "maxLength":1000
        },
        "OrderNumber":{
            "title":"Order",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "type":"string",
            "maxLength":30
        },
        "Ordered":{
            "title":"Ordered",
            "description":"Total of the amounts from the purchase order lines. Do not include exclusive taxes.",
            "type":"number"
        },
        "POHeaderId":{
            "description":"Value that uniquely identifies the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "PayOnReceiptFlag":{
            "title":"Pay on Receipt",
            "description":"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.",
            "type":"boolean"
        },
        "PaymentTerms":{
            "description":"Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.",
            "type":"string",
            "maxLength":50
        },
        "PaymentTermsId":{
            "description":"Value that uniquely identifies the payment terms.",
            "type":"integer",
            "format":"int64"
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "description":"Business unit that manages and owns the purchase order.",
            "type":"string",
            "maxLength":240
        },
        "ProcurementBUId":{
            "description":"Value that uniquely identifies the business unit that manages and owns the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "description":"Document number of the purchase order that the import imported from the legacy application into Oracle Purchasing Cloud.",
            "type":"string",
            "maxLength":120
        },
        "RequiredAcknowledgment":{
            "title":"Required Acknowledgment",
            "description":"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.",
            "type":"string",
            "maxLength":80
        },
        "RequiredAcknowledgmentCode":{
            "title":"Required Acknowledgment",
            "description":"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.",
            "type":"string",
            "maxLength":1
        },
        "RequiresSignatureFlag":{
            "title":"Allow Substitute Receipts",
            "description":"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.",
            "type":"boolean"
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "description":"Business unit that creates the requisition.",
            "type":"string",
            "maxLength":240
        },
        "RequisitioningBUId":{
            "description":"Value that uniquely identifies the business unit that creates the requisition.",
            "type":"integer",
            "format":"int64"
        },
        "Revision":{
            "title":"Revision",
            "description":"Versions of the purchase order that requires communication to and, as an option, get acknowledgment from the supplier.",
            "type":"number"
        },
        "ServiceLevel":{
            "title":"Service Level",
            "description":"Priority that determines how quickly to transport the item.",
            "type":"string",
            "maxLength":80
        },
        "ServiceLevelCode":{
            "description":"Abbreviation that identifies the service level for the shipping method.",
            "type":"string",
            "maxLength":30
        },
        "ShippingMethod":{
            "title":"Shipping Method",
            "description":"Transportation method for the carrier or service level for the purchase order. For example, ABC Shipping - AIR - 2nd Day.",
            "type":"string",
            "maxLength":255
        },
        "SoldToLegalEntity":{
            "title":"Sold-to Legal Entity",
            "description":"Party who is financially responsible for purchases on the purchase order.",
            "type":"string",
            "maxLength":240
        },
        "SoldToLegalEntityId":{
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "Status":{
            "title":"Status",
            "description":"Status of the purchase order relative to the purchase order life cycle.",
            "type":"string",
            "maxLength":80
        },
        "StatusCode":{
            "title":"Status Code",
            "description":"Abbreviation that identifies the purchase order status in the order life cycle.",
            "type":"string",
            "maxLength":25
        },
        "Supplier":{
            "title":"Supplier",
            "description":"Supplier who fulfills the item.",
            "type":"string",
            "maxLength":360
        },
        "SupplierContact":{
            "title":"Supplier Contact",
            "description":"Person who represents the supplier when communicating with the buyer.",
            "type":"string",
            "maxLength":360
        },
        "SupplierContactId":{
            "description":"Value that uniquely identifies the supplier contact.",
            "type":"integer",
            "format":"int64"
        },
        "SupplierId":{
            "description":"Value that uniquely identifies the supplier.",
            "type":"integer",
            "format":"int64"
        },
        "SupplierOrder":{
            "title":"Supplier Order",
            "description":"Document number that the supplier created for the purchase order.",
            "type":"string",
            "maxLength":25
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "description":"Location that the supplier uses to purchase the item.",
            "type":"string",
            "maxLength":15
        },
        "SupplierSiteId":{
            "description":"Value that uniquely identifies the supplier site.",
            "type":"integer",
            "format":"int64"
        },
        "Total":{
            "title":"Total",
            "description":"Ordered amount plus the exclusive tax amounts for the purchase order.",
            "type":"number"
        },
        "TotalTax":{
            "title":"Total Tax",
            "description":"Exclusive tax amount that the purchase can recover and not recover for the purchase order.",
            "type":"number"
        },
        "attachments":{
            "title":"Attachments for Purchase Orders",
            "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-attachments-item"
            }
        },
        "lines":{
            "title":"Lines",
            "description":"The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-item"
            }
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

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

• Array of: object purchaseOrders-attachments-item

{
    "title":"Attachments for Purchase Orders",
    "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-attachments-item"
    }
}

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

• Array of: object purchaseOrders-DFF-item
  Discriminator: __FLEX_Context

{
    "title":"Flexfields for Purchase Orders",
    "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-DFF-item"
    }
}

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

• Array of: object purchaseOrders-lines-item

{
    "title":"Lines",
    "description":"The Lines resource manages purchasing details, such as the item to purchase, quantity, unit of measure, and price.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-attachments-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId(optional): 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(optional): string
  Title: Category

  Maximum Length: 30

  Category of the attached document.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 255

  User who created the attached document.
• CreatedByUserName(optional): string
  Title: Created By User Name

  Login that the user used when creating the document that is attached to the purchase order.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  Date when the user created the attached document.
• DatatypeCode(optional): string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the data type.
• Description(optional): string
  Title: Description

  Maximum Length: 255

  Description of the attached document.
• DmDocumentId(optional): string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath(optional): string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attached document.
• DmVersionNumber(optional): string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo(optional): string
  Title: DownloadInfo

  JSON-formatted string that contains information required to programmatically retrieve a large file attachment.
• ErrorStatusCode(optional): string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attached document.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  Text of the error message, if any, for the attached document.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  Date when the content in the attached document expires.
• FileContents(optional): string(binary)
  Title: File Contents

  Contents of the attached document.
• FileName(optional): string
  Title: File Name

  Maximum Length: 2048

  File name of the attached document.
• FileUrl(optional): string
  Title: File Url

  URL (Uniform Resource Locator) of the attached document.
• FileWebImage(optional): string(binary)
  Title: File Web Image

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

  Date and time when the user most recently updated the document that is attached to the purchase order.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

  User who most recently updated the document that is attached to the purchase order.
• LastUpdatedByUserName(optional): string
  Title: Last Updated By User

  Login that the user used when updating the document that is attached to the purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

  Title of the attached document.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

  Content type of the attached document.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

  Length of the attached document.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  Name of the attached document.
• UploadedText(optional): string
  Title: Uploaded Text

  Text of the attached document.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  Login that the user used when adding or modifying the attached document.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "description":"An identifier used for tracking the uploaded files.",
            "type":"string"
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "CategoryName":{
            "title":"Category",
            "description":"Category of the attached document.",
            "type":"string",
            "maxLength":30
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "description":"Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.",
            "type":"boolean"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"User who created the attached document.",
            "type":"string",
            "maxLength":255
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "description":"Login that the user used when creating the document that is attached to the purchase order.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"Date when the user created the attached document.",
            "type":"string",
            "format":"date-time"
        },
        "DatatypeCode":{
            "title":"Type",
            "description":"Abbreviation that identifies the data type.",
            "type":"string",
            "maxLength":30
        },
        "Description":{
            "title":"Description",
            "description":"Description of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmDocumentId":{
            "description":"Value that uniquely identifies the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "description":"Folder path of the attached document.",
            "type":"string",
            "maxLength":1000
        },
        "DmVersionNumber":{
            "description":"Number that identifies the version of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large file attachment.",
            "type":"string"
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "description":"Abbreviation that identifies the error code, if any, for the attached document.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "description":"Text of the error message, if any, for the attached document.",
            "type":"string"
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "description":"Date when the content in the attached document expires.",
            "type":"string",
            "format":"date-time"
        },
        "FileContents":{
            "title":"File Contents",
            "description":"Contents of the attached document.",
            "type":"string",
            "format":"binary"
        },
        "FileName":{
            "title":"File Name",
            "description":"File name of the attached document.",
            "type":"string",
            "maxLength":2048
        },
        "FileUrl":{
            "title":"File Url",
            "description":"URL (Uniform Resource Locator) of the attached document.",
            "type":"string"
        },
        "FileWebImage":{
            "title":"File Web Image",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "type":"string",
            "format":"binary"
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "description":"Date and time when the user most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"User who most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "maxLength":255
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "description":"Login that the user used when updating the document that is attached to the purchase order.",
            "type":"string"
        },
        "Title":{
            "title":"Title",
            "description":"Title of the attached document.",
            "type":"string"
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "description":"Content type of the attached document.",
            "type":"string"
        },
        "UploadedFileLength":{
            "title":"File Size",
            "description":"Length of the attached document.",
            "type":"integer",
            "format":"int64"
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "description":"Name of the attached document.",
            "type":"string"
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "description":"Text of the attached document.",
            "type":"string"
        },
        "Uri":{
            "title":"Uri",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "Url":{
            "title":"Url",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "UserName":{
            "title":"User Name",
            "description":"Login that the user used when adding or modifying the attached document.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Nested Schema : purchaseOrders-DFF-item

Type: object

Discriminator: __FLEX_Context

Show Source

• __FLEX_Context: string
  Maximum Length: 30

  Descriptive flexfield context name for purchase order.
• _FLEX_NumOfSegments(optional): integer(int32)
  Descriptive flexfield number of segments for purchase order.
• _FLEX_NumOfVisibleSegments(optional): integer(int32)
  Descriptive flexfield number of visible segments for purchase order.
• _FLEX_ValidationDate(optional): string(date)
  Descriptive flexfield validation date for purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• PoHeaderId(optional): integer(int64)
  Value that uniquely identifies the purchase order.

{
    "type":"object",
    "properties":{
        "PoHeaderId":{
            "description":"Value that uniquely identifies the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "_FLEX_NumOfSegments":{
            "description":"Descriptive flexfield number of segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_NumOfVisibleSegments":{
            "description":"Descriptive flexfield number of visible segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_ValidationDate":{
            "description":"Descriptive flexfield validation date for purchase order.",
            "type":"string",
            "format":"date"
        },
        "__FLEX_Context":{
            "description":"Descriptive flexfield context name for purchase order.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "__FLEX_Context"
    ],
    "discriminator":"__FLEX_Context"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-item

Type: object

Show Source

• attachments(optional): array Attachments for Purchase Orders
  Title: Attachments for Purchase Orders

  The Attachments for Purchase Orders resource manage attachments for a purchase order.
• BasePrice(optional): number
  Title: Base Price

  Original price for each unit of the offered item or service. This attribute is associated with a feature that requires opt in.
• Category(optional): string
  Title: Category Name

  Maximum Length: 2400

  Name of the purchasing category that the purchase order uses to classify the purchase for the order line.
• CategoryCode(optional): string
  Maximum Length: 820

  Abbreviation that identifies the purchasing category.
• CategoryId(optional): integer(int64)
  Value that uniquely identifies the purchasing category.
• ConsignmentLineFlag(optional): boolean
  Title: Consignment Line

  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(optional): string
  Maximum Length: 64

  User who created the purchase order line.
• CreationDate(optional): string(date-time)
  Date and time when the buyer or application created the purchase order line.
• Currency(optional): string
  Title: Currency

  Maximum Length: 80

  Purchase order currency.
• CurrencyCode(optional): string
  Maximum Length: 15

  Abbreviation that identifies the purchase order currency.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  Description of the item that the purchase order references.
• DFF(optional): array Flexfields for Purchase Orders
  Title: Flexfields for Purchase Orders

  The Flexfields for Purchase Orders resource manages additional details about purchase orders.
• Discount(optional): number
  Title: Discount

  Value that indicates the discount percent or amount of the purchase order line.
• DiscountReason(optional): string
  Title: Discount Reason

  Maximum Length: 240

  Reason for the discount.
• DiscountType(optional): string
  Title: Meaning

  Maximum Length: 80

  Type of discount that indicates whether the discount is based on amount or percent.
• HazardClass(optional): string
  Title: Hazard Class

  Maximum Length: 40

  Name of the hazard class that is used to identify and classify hazardous materials to comply with the safety regulations.
• HazardClassCode(optional): string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the hazard class.
• HazardClassId(optional): integer(int64)
  Value that uniquely identifies the hazard class.
• Item(optional): string
  Title: Item

  Abbreviation that uniquely identifies the item on the purchase order.
• ItemId(optional): integer(int64)
  Value that uniquely identifies the item on the purchase order.
• ItemRevision(optional): string
  Title: Item Revision

  Maximum Length: 18

  Revision number of the item.
• LastUpdateDate(optional): string(date-time)
  Date and time when the buyer or application most recently updated the purchase order line.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  User who most recently updated the purchase order line.
• LineNumber(optional): number
  Title: Line

  Number that uniquely identifies the purchase order line.
• LineType(optional): string
  Title: Line Type

  Maximum Length: 30

  Type that indicates whether the purchase order line references an item or a service.
• LineTypeId(optional): integer(int64)
  Value that uniquely identifies whether the purchase order line references an item or a service.
• links(optional): array Items
  Title: Items

  Link Relations
• Manufacturer(optional): string
  Title: Manufacturer

  Maximum Length: 700

  Name of the manufacturer of the item.
• ManufacturerPartNumber(optional): string
  Title: Manufacturer Part Number

  Maximum Length: 700

  Number issued by the manufacturer that uniquely identifies the individual product.
• MaximumRetainageAmount(optional): number
  Title: Maximum Retainage Amount

  Maximum amount of retainage that can be withheld on a contract line.
• NegotiatedFlag(optional): boolean
  Title: Negotiated

  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(optional): string
  Title: Note to Supplier

  Maximum Length: 1000

  Note that the supplier can read to get details about how to process the order line on the purchase order.
• Ordered(optional): number
  Title: Ordered

  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(optional): string
  Title: Order

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• POHeaderId(optional): integer(int64)
  Value that uniquely identifies the purchase order.
• POLineId(optional): integer(int64)
  Value that uniquely identifies the purchase order line.
• Price(optional): number
  Title: Price

  Price of the purchase order line.
• PricingUOM(optional): string
  Title: Pricing UOM

  Maximum Length: 25

  Unit of measure that the item uses for pricing.
• PricingUOMCode(optional): string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure the item uses for pricing.
• Quantity(optional): number
  Title: Quantity

  Quantity of the item on the order line.
• schedules(optional): array Schedules
  Title: Schedules

  The Schedules resource manages purchasing details, such as ship-to location and delivery date.
• SecondaryQuantity(optional): number
  Title: Secondary Quantity

  Quantity on the order line in the secondary unit of measure. Applies when more than one unit of measure controls the item.
• SecondaryUOM(optional): string
  Title: Secondary UOM

  Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.
• SecondaryUOMCode(optional): string
  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(optional): integer(int64)
  Value that uniquely identifies the source agreement that the purchase order line references.
• SourceAgreementLine(optional): number
  Title: Source Agreement Line

  Number that uniquely identifies the source agreement line that the purchase order line references.
• SourceAgreementLineId(optional): integer(int64)
  Value that uniquely identifies the source agreement line that the purchase order line references.
• SourceAgreementNumber(optional): string
  Title: Source Agreement

  Maximum Length: 30

  Number that uniquely identifies the source agreement that the purchase order line references.
• SourceAgreementProcurementBU(optional): string
  Title: Source Agreement Procurement BU

  Business unit of the purchase agreement against which this purchase order line is released.
• SourceAgreementProcurementBUId(optional): integer(int64)
  Value that uniquely identifies the business unit of the purchase agreement against which this purchase order line is released.
• SourceAgreementType(optional): string
  Title: Source Agreement Document Type

  Maximum Length: 80

  Specifies whether the agreement is a blanket purchase agreement or a contract purchase agreement.
• SourceAgreementTypeCode(optional): string
  Maximum Length: 25

  Source agreement type. For example, CONTRACT or BLANKET.
• Status(optional): string
  Title: Status

  Maximum Length: 80

  Status of the purchase order line.
• StatusCode(optional): string
  Title: Line Status

  Maximum Length: 25

  Abbreviation that identifies the status of the purchase order line.
• SupplierConfigurationId(optional): string
  Title: Supplier Configuration ID

  Maximum Length: 150

  Value that uniquely identifies the configured item that the requester created in the supplier application when creating the requisition.
• SupplierItem(optional): string
  Title: Supplier Item

  Maximum Length: 300

  Number that the supplier uses to identify the item on the purchase order line.
• Total(optional): number
  Title: Total

  Ordered amount plus the exclusive tax amounts on the purchase order line.
• TotalTax(optional): number
  Title: Total Tax

  Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order line.
• UNNumber(optional): string
  Title: UN Number

  Maximum Length: 20

  Number that the United Nations uses to identify hazardous material.
• UNNumberDescription(optional): string
  Title: UN Number Description

  Maximum Length: 240

  Description of the hazardous material that the United Nations identification number references.
• UNNumberId(optional): integer(int64)
  Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
• UOM(optional): string
  Title: UOM

  Maximum Length: 25

  Unit of measure that the item uses for the quantity.
• UOMCode(optional): string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• WorkOrderProduct(optional): string
  Maximum Length: 300

  Finished item that the work order in contract manufacturing creates.

{
    "type":"object",
    "properties":{
        "BasePrice":{
            "title":"Base Price",
            "description":"Original price for each unit of the offered item or service. This attribute is associated with a feature that requires opt in.",
            "type":"number"
        },
        "Category":{
            "title":"Category Name",
            "description":"Name of the purchasing category that the purchase order uses to classify the purchase for the order line.",
            "type":"string",
            "maxLength":2400
        },
        "CategoryCode":{
            "description":"Abbreviation that identifies the purchasing category.",
            "type":"string",
            "maxLength":820
        },
        "CategoryId":{
            "description":"Value that uniquely identifies the purchasing category.",
            "type":"integer",
            "format":"int64"
        },
        "ConsignmentLineFlag":{
            "title":"Consignment Line",
            "description":"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.",
            "type":"boolean"
        },
        "CreatedBy":{
            "description":"User who created the purchase order line.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"Date and time when the buyer or application created the purchase order line.",
            "type":"string",
            "format":"date-time"
        },
        "Currency":{
            "title":"Currency",
            "description":"Purchase order currency.",
            "type":"string",
            "maxLength":80
        },
        "CurrencyCode":{
            "description":"Abbreviation that identifies the purchase order currency.",
            "type":"string",
            "maxLength":15
        },
        "DFF":{
            "title":"Flexfields for Purchase Orders",
            "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-DFF-item"
            }
        },
        "Description":{
            "title":"Description",
            "description":"Description of the item that the purchase order references.",
            "type":"string",
            "maxLength":240
        },
        "Discount":{
            "title":"Discount",
            "description":"Value that indicates the discount percent or amount of the purchase order line.",
            "type":"number"
        },
        "DiscountReason":{
            "title":"Discount Reason",
            "description":"Reason for the discount.",
            "type":"string",
            "maxLength":240
        },
        "DiscountType":{
            "title":"Meaning",
            "description":"Type of discount that indicates whether the discount is based on amount or percent.",
            "type":"string",
            "maxLength":80
        },
        "HazardClass":{
            "title":"Hazard Class",
            "description":"Name of the hazard class that is used to identify and classify hazardous materials to comply with the safety regulations.",
            "type":"string",
            "maxLength":40
        },
        "HazardClassCode":{
            "title":"Code",
            "description":"Abbreviation that identifies the hazard class.",
            "type":"string",
            "maxLength":30
        },
        "HazardClassId":{
            "description":"Value that uniquely identifies the hazard class.",
            "type":"integer",
            "format":"int64"
        },
        "Item":{
            "title":"Item",
            "description":"Abbreviation that uniquely identifies the item on the purchase order.",
            "type":"string"
        },
        "ItemId":{
            "description":"Value that uniquely identifies the item on the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "ItemRevision":{
            "title":"Item Revision",
            "description":"Revision number of the item.",
            "type":"string",
            "maxLength":18
        },
        "LastUpdateDate":{
            "description":"Date and time when the buyer or application most recently updated the purchase order line.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"User who most recently updated the purchase order line.",
            "type":"string",
            "maxLength":64
        },
        "LineNumber":{
            "title":"Line",
            "description":"Number that uniquely identifies the purchase order line.",
            "type":"number"
        },
        "LineType":{
            "title":"Line Type",
            "description":"Type that indicates whether the purchase order line references an item or a service.",
            "type":"string",
            "maxLength":30
        },
        "LineTypeId":{
            "description":"Value that uniquely identifies whether the purchase order line references an item or a service.",
            "type":"integer",
            "format":"int64"
        },
        "Manufacturer":{
            "title":"Manufacturer",
            "description":"Name of the manufacturer of the item.",
            "type":"string",
            "maxLength":700
        },
        "ManufacturerPartNumber":{
            "title":"Manufacturer Part Number",
            "description":"Number issued by the manufacturer that uniquely identifies the individual product.",
            "type":"string",
            "maxLength":700
        },
        "MaximumRetainageAmount":{
            "title":"Maximum Retainage Amount",
            "description":"Maximum amount of retainage that can be withheld on a contract line.",
            "type":"number"
        },
        "NegotiatedFlag":{
            "title":"Negotiated",
            "description":"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.",
            "type":"boolean"
        },
        "NoteToSupplier":{
            "title":"Note to Supplier",
            "description":"Note that the supplier can read to get details about how to process the order line on the purchase order.",
            "type":"string",
            "maxLength":1000
        },
        "OrderNumber":{
            "title":"Order",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "type":"string",
            "maxLength":30
        },
        "Ordered":{
            "title":"Ordered",
            "description":"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.",
            "type":"number"
        },
        "POHeaderId":{
            "description":"Value that uniquely identifies the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "POLineId":{
            "description":"Value that uniquely identifies the purchase order line.",
            "type":"integer",
            "format":"int64"
        },
        "Price":{
            "title":"Price",
            "description":"Price of the purchase order line.",
            "type":"number"
        },
        "PricingUOM":{
            "title":"Pricing UOM",
            "description":"Unit of measure that the item uses for pricing.",
            "type":"string",
            "maxLength":25
        },
        "PricingUOMCode":{
            "description":"Abbreviation that identifies the unit of measure the item uses for pricing.",
            "type":"string",
            "maxLength":3
        },
        "Quantity":{
            "title":"Quantity",
            "description":"Quantity of the item on the order line.",
            "type":"number"
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "description":"Quantity on the order line in the secondary unit of measure. Applies when more than one unit of measure controls the item.",
            "type":"number"
        },
        "SecondaryUOM":{
            "title":"Secondary UOM",
            "description":"Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.",
            "type":"string"
        },
        "SecondaryUOMCode":{
            "description":"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.",
            "type":"string"
        },
        "SourceAgreementId":{
            "description":"Value that uniquely identifies the source agreement that the purchase order line references.",
            "type":"integer",
            "format":"int64"
        },
        "SourceAgreementLine":{
            "title":"Source Agreement Line",
            "description":"Number that uniquely identifies the source agreement line that the purchase order line references.",
            "type":"number"
        },
        "SourceAgreementLineId":{
            "description":"Value that uniquely identifies the source agreement line that the purchase order line references.",
            "type":"integer",
            "format":"int64"
        },
        "SourceAgreementNumber":{
            "title":"Source Agreement",
            "description":"Number that uniquely identifies the source agreement that the purchase order line references.",
            "type":"string",
            "maxLength":30
        },
        "SourceAgreementProcurementBU":{
            "title":"Source Agreement Procurement BU",
            "description":"Business unit of the purchase agreement against which this purchase order line is released.",
            "type":"string"
        },
        "SourceAgreementProcurementBUId":{
            "description":"Value that uniquely identifies the business unit of the purchase agreement against which this purchase order line is released.",
            "type":"integer",
            "format":"int64"
        },
        "SourceAgreementType":{
            "title":"Source Agreement Document Type",
            "description":"Specifies whether the agreement is a blanket purchase agreement or a contract purchase agreement.",
            "type":"string",
            "maxLength":80
        },
        "SourceAgreementTypeCode":{
            "description":"Source agreement type. For example, CONTRACT or BLANKET.",
            "type":"string",
            "maxLength":25
        },
        "Status":{
            "title":"Status",
            "description":"Status of the purchase order line.",
            "type":"string",
            "maxLength":80
        },
        "StatusCode":{
            "title":"Line Status",
            "description":"Abbreviation that identifies the status of the purchase order line.",
            "type":"string",
            "maxLength":25
        },
        "SupplierConfigurationId":{
            "title":"Supplier Configuration ID",
            "description":"Value that uniquely identifies the configured item that the requester created in the supplier application when creating the requisition.",
            "type":"string",
            "maxLength":150
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "description":"Number that the supplier uses to identify the item on the purchase order line.",
            "type":"string",
            "maxLength":300
        },
        "Total":{
            "title":"Total",
            "description":"Ordered amount plus the exclusive tax amounts on the purchase order line.",
            "type":"number"
        },
        "TotalTax":{
            "title":"Total Tax",
            "description":"Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order line.",
            "type":"number"
        },
        "UNNumber":{
            "title":"UN Number",
            "description":"Number that the United Nations uses to identify hazardous material.",
            "type":"string",
            "maxLength":20
        },
        "UNNumberDescription":{
            "title":"UN Number Description",
            "description":"Description of the hazardous material that the United Nations identification number references.",
            "type":"string",
            "maxLength":240
        },
        "UNNumberId":{
            "description":"Value that uniquely identifies the number that the United Nations uses to identify hazardous material.",
            "type":"integer",
            "format":"int64"
        },
        "UOM":{
            "title":"UOM",
            "description":"Unit of measure that the item uses for the quantity.",
            "type":"string",
            "maxLength":25
        },
        "UOMCode":{
            "description":"Abbreviation that identifies the unit of measure.",
            "type":"string",
            "maxLength":3
        },
        "WorkOrderProduct":{
            "description":"Finished item that the work order in contract manufacturing creates.",
            "type":"string",
            "maxLength":300
        },
        "attachments":{
            "title":"Attachments for Purchase Orders",
            "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-attachments-item"
            }
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "schedules":{
            "title":"Schedules",
            "description":"The Schedules resource manages purchasing details, such as ship-to location and delivery date.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-item"
            }
        }
    }
}

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

• Array of: object purchaseOrders-lines-attachments-item

{
    "title":"Attachments for Purchase Orders",
    "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-attachments-item"
    }
}

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

• Array of: object purchaseOrders-lines-DFF-item
  Discriminator: __FLEX_Context

{
    "title":"Flexfields for Purchase Orders",
    "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-DFF-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : Schedules

Type: array

Title: Schedules

The Schedules resource manages purchasing details, such as ship-to location and delivery date.

Show Source

• Array of: object purchaseOrders-lines-schedules-item

{
    "title":"Schedules",
    "description":"The Schedules resource manages purchasing details, such as ship-to location and delivery date.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-item"
    }
}

Nested Schema : purchaseOrders-lines-attachments-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId(optional): 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(optional): string
  Title: Category

  Maximum Length: 30

  Category of the attached document.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 255

  User who created the attached document.
• CreatedByUserName(optional): string
  Title: Created By User Name

  Login that the user used when creating the document that is attached to the purchase order.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  Date when the user created the attached document.
• DatatypeCode(optional): string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the data type.
• Description(optional): string
  Title: Description

  Maximum Length: 255

  Description of the attached document.
• DmDocumentId(optional): string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath(optional): string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attached document.
• DmVersionNumber(optional): string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo(optional): string
  Title: DownloadInfo

  JSON-formatted string that contains information required to programmatically retrieve a large file attachment.
• ErrorStatusCode(optional): string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attached document.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  Text of the error message, if any, for the attached document.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  Date when the content in the attached document expires.
• FileContents(optional): string(binary)
  Title: File Contents

  Contents of the attached document.
• FileName(optional): string
  Title: File Name

  Maximum Length: 2048

  File name of the attached document.
• FileUrl(optional): string
  Title: File Url

  URL (Uniform Resource Locator) of the attached document.
• FileWebImage(optional): string(binary)
  Title: File Web Image

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

  Date and time when the user most recently updated the document that is attached to the purchase order.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

  User who most recently updated the document that is attached to the purchase order.
• LastUpdatedByUserName(optional): string
  Title: Last Updated By User

  Login that the user used when updating the document that is attached to the purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

  Title of the attached document.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

  Content type of the attached document.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

  Length of the attached document.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  Name of the attached document.
• UploadedText(optional): string
  Title: Uploaded Text

  Text of the attached document.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  Login that the user used when adding or modifying the attached document.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "description":"An identifier used for tracking the uploaded files.",
            "type":"string"
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "CategoryName":{
            "title":"Category",
            "description":"Category of the attached document.",
            "type":"string",
            "maxLength":30
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "description":"Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.",
            "type":"boolean"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"User who created the attached document.",
            "type":"string",
            "maxLength":255
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "description":"Login that the user used when creating the document that is attached to the purchase order.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"Date when the user created the attached document.",
            "type":"string",
            "format":"date-time"
        },
        "DatatypeCode":{
            "title":"Type",
            "description":"Abbreviation that identifies the data type.",
            "type":"string",
            "maxLength":30
        },
        "Description":{
            "title":"Description",
            "description":"Description of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmDocumentId":{
            "description":"Value that uniquely identifies the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "description":"Folder path of the attached document.",
            "type":"string",
            "maxLength":1000
        },
        "DmVersionNumber":{
            "description":"Number that identifies the version of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large file attachment.",
            "type":"string"
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "description":"Abbreviation that identifies the error code, if any, for the attached document.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "description":"Text of the error message, if any, for the attached document.",
            "type":"string"
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "description":"Date when the content in the attached document expires.",
            "type":"string",
            "format":"date-time"
        },
        "FileContents":{
            "title":"File Contents",
            "description":"Contents of the attached document.",
            "type":"string",
            "format":"binary"
        },
        "FileName":{
            "title":"File Name",
            "description":"File name of the attached document.",
            "type":"string",
            "maxLength":2048
        },
        "FileUrl":{
            "title":"File Url",
            "description":"URL (Uniform Resource Locator) of the attached document.",
            "type":"string"
        },
        "FileWebImage":{
            "title":"File Web Image",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "type":"string",
            "format":"binary"
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "description":"Date and time when the user most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"User who most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "maxLength":255
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "description":"Login that the user used when updating the document that is attached to the purchase order.",
            "type":"string"
        },
        "Title":{
            "title":"Title",
            "description":"Title of the attached document.",
            "type":"string"
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "description":"Content type of the attached document.",
            "type":"string"
        },
        "UploadedFileLength":{
            "title":"File Size",
            "description":"Length of the attached document.",
            "type":"integer",
            "format":"int64"
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "description":"Name of the attached document.",
            "type":"string"
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "description":"Text of the attached document.",
            "type":"string"
        },
        "Uri":{
            "title":"Uri",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "Url":{
            "title":"Url",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "UserName":{
            "title":"User Name",
            "description":"Login that the user used when adding or modifying the attached document.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-DFF-item

Type: object

Discriminator: __FLEX_Context

Show Source

• __FLEX_Context: string
  Maximum Length: 30

  Descriptive flexfield context name for purchase order.
• _FLEX_NumOfSegments(optional): integer(int32)
  Descriptive flexfield number of segments for purchase order.
• _FLEX_NumOfVisibleSegments(optional): integer(int32)
  Descriptive flexfield number of visible segments for purchase order.
• _FLEX_ValidationDate(optional): string(date)
  Descriptive flexfield validation date for purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• PoLineId(optional): integer(int64)
  Value that uniquely identifies the purchase order line.

{
    "type":"object",
    "properties":{
        "PoLineId":{
            "description":"Value that uniquely identifies the purchase order line.",
            "type":"integer",
            "format":"int64"
        },
        "_FLEX_NumOfSegments":{
            "description":"Descriptive flexfield number of segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_NumOfVisibleSegments":{
            "description":"Descriptive flexfield number of visible segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_ValidationDate":{
            "description":"Descriptive flexfield validation date for purchase order.",
            "type":"string",
            "format":"date"
        },
        "__FLEX_Context":{
            "description":"Descriptive flexfield context name for purchase order.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "__FLEX_Context"
    ],
    "discriminator":"__FLEX_Context"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-schedules-item

Type: object

Show Source

• AccrueAtReceiptFlag(optional): boolean
  Title: Accrue at Receipt

  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(optional): boolean
  Title: Allow Substitute Receipts

  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(optional): array Attachments for Purchase Orders
  Title: Attachments for Purchase Orders

  The Attachments for Purchase Orders resource manage attachments for a purchase order.
• BackToBackFlag(optional): boolean
  Title: Back-to-Back Order

  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.
• Carrier(optional): string
  Title: Carrier

  Maximum Length: 360

  Company that transports the item.
• CarrierId(optional): integer(int64)
  Value that uniquely identifies the company that transports the item.
• CountryOfOrigin(optional): string
  Title: Country of Origin

  Maximum Length: 80

  Country where the organization that ships and exports the item resides.
• CountryOfOriginCode(optional): string
  Title: Country of Origin

  Maximum Length: 2

  Abbreviation that identifies the country where the organization resides that ships and exports the item.
• CreatedBy(optional): string
  Maximum Length: 64

  User who created the purchase order schedule.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  Date and time when the buyer or application created the purchase order schedule.
• Currency(optional): string
  Title: Currency

  Maximum Length: 80

  Purchase order currency.
• CurrencyCode(optional): string
  Maximum Length: 15

  Abbreviation that identifies the purchase order currency.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• DestinationType(optional): string
  Title: Destination Type

  Maximum Length: 80

  Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order.
• DestinationTypeCode(optional): string
  Title: Destination Type

  Maximum Length: 25

  How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING.
• DFF(optional): array Flexfields for Purchase Orders
  Title: Flexfields for Purchase Orders

  The Flexfields for Purchase Orders resource manages additional details about purchase orders.
• distributions(optional): array Distributions
  Title: Distributions

  The Distributions resource manages purchasing details, such as details about accounting or the project.
• EarlyReceiptToleranceDays(optional): number
  Maximum number of days the application allows to receive an early shipment.
• InvoiceCloseTolerancePercent(optional): number
  Title: Invoice Close Tolerance Percent

  Percent that the application uses to determine whether to close a purchase order schedule when the invoice invoices only part of the item.
• InvoiceMatchOption(optional): string
  Title: Invoice Match Option

  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(optional): string
  Title: Invoice Match Option

  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(optional): string(date)
  Title: Last Acceptable Delivery Date

  Last date when the shipper can deliver the item.
• LastAcceptableShipDate(optional): string(date)
  Title: Last Acceptable Ship Date

  Last date when the shipper can ship the item.
• LastAcceptDate(optional): string(date)
  Last date when the receiver can receive the item.
• LastUpdateDate(optional): string(date-time)
  Date and time when the buyer or application most recently updated the purchase order schedule.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  User who most recently updated the purchase order schedule.
• LateReceiptToleranceDays(optional): number
  Maximum number of days the application allows to receive a late shipment.
• LineLocationId(optional): integer(int64)
  Value that uniquely identifies the purchase order schedule.
• LineNumber(optional): number
  Title: Line

  Number that uniquely identifies the purchase order line.
• links(optional): array Items
  Title: Items

  Link Relations
• MatchApprovalLevelCode(optional): string
  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(optional): string
  Title: Mode of Transport

  Maximum Length: 80

  Mode of transportation that ships the item, such as truck, air, or boat.
• ModeOfTransportCode(optional): string
  Maximum Length: 30

  Abbreviation that identifies the mode of transport.
• NoteToReceiver(optional): string
  Title: Note to Receiver

  Maximum Length: 1000

  Note that the receiver can read to get details about how to process the purchase order schedule.
• OrchestrationAgreementLineNumber(optional): integer(int64)
  Number that identifies the orchestration agreement line.
• OrchestrationAgreementNumber(optional): string
  Title: Financial Orchestration Flow

  Maximum Length: 100

  Number that identifies the orchestration agreement between the legal entities, business units, and trade organizations establishing a trade relationship.
• Ordered(optional): number
  Title: Ordered

  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(optional): string
  Title: Order

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• OriginalPromisedDeliveryDate(optional): string(date)
  Title: Original Promised Delivery Date

  Date when the supplier promises to deliver the item that the buyer ordered.
• OriginalPromisedShipDate(optional): string(date)
  Title: Original Promised Ship Date

  Date when the supplier promises to ship the item that the buyer ordered.
• OverReceiptAction(optional): string
  Title: Over-receipt Action

  Maximum Length: 80

  Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include None, Reject, or Warning.
• OverReceiptActionCode(optional): string
  Maximum Length: 25

  Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include NONE, REJECT, or WARNING.
• OverReceiptTolerancePercent(optional): number
  Title: Over-receipt Tolerance Percent

  Percent tolerance to use when receiving more than the ordered quantity or amount without starting the action that the OverReceiptActionCode attribute specifies.
• POHeaderId(optional): integer(int64)
  Value that uniquely identifies the purchase order.
• POLineId(optional): integer(int64)
  Value that uniquely identifies the parent of the purchase order line.
• POTradingOrganization(optional): string
  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(optional): string
  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(optional): integer(int64)
  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(optional): number
  Title: Price

  Price of the purchase order line.
• PricingUOM(optional): string
  Title: Pricing UOM

  Maximum Length: 25

  Abbreviation that identifies the unit of measure the item uses for pricing.
• PricingUOMCode(optional): string
  Maximum Length: 3

  Unit of measure that the item uses for pricing.
• PrimaryTradeRelationshipId(optional): integer(int64)
  Value that uniquely identifies the primary trade relationship in an orchestration agreement.
• PromisedDeliveryDate(optional): string(date)
  Title: Promised Delivery Date

  Date when the supplier promises to deliver the item to the buyer.
• PromisedShipDate(optional): string(date)
  Title: Promised Ship Date

  Date when the supplier promises to ship the item to the buyer.
• Quantity(optional): number
  Title: Quantity

  Scheduled quantity of the item.
• ReceiptCloseTolerancePercent(optional): number
  Title: Receipt Close Tolerance Percent

  Percent that the application uses to determine whether to close a purchase order schedule when the receiver receives only part of the item.
• ReceiptDateExceptionAction(optional): string
  Title: Receipt Date Exception Action

  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(optional): string
  Title: Receipt Date Exception Action

  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(optional): string
  Title: Receipt Routing

  Maximum Length: 80

  Routing to use when receiving the item. Values include Standard Receipt, Inspection Required, or Direct Delivery.
• ReceiptRoutingId(optional): integer(int64)
  How to simplify transaction entry when routing the receipt. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
• RequestedDeliveryDate(optional): string(date)
  Title: Requested Delivery Date

  Date when the buyer requests that the supplier deliver the item.
• RequestedShipDate(optional): string(date)
  Title: Requested Ship Date

  Date when the buyer requests that the supplier ship the item.
• RetainageAmount(optional): number
  Title: Retainage

  Total amount withheld as retainage against the schedule.
• RetainageRate(optional): number
  Title: Retainage Rate

  Percentage of the invoice value that can be withheld as retainage.
• RetainageReleasedAmount(optional): number
  Title: Retainage Released

  Amount of retainage released for the schedule.
• SalesOrderNumber(optional): string
  Title: Customer Sales Order

  Maximum Length: 50

  Number that uniquely identifies the sales order that the purchase order schedule references.
• ScheduleNumber(optional): number
  Title: Schedule

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• SecondaryQuantity(optional): number
  Title: Secondary Quantity

  Scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.
• SecondaryUOM(optional): string
  Title: Secondary UOM

  Maximum Length: 25

  Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.
• SecondaryUOMCode(optional): string
  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(optional): string
  Title: Ship-to Party

  Maximum Length: 360

  Name of the party who receives the item that the supplier ships.
• ShipToCustomerId(optional): integer(int64)
  Value that uniquely identifies the third party that receives the item.
• ShipToExceptionAction(optional): string
  Title: Ship-to Exception Action

  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(optional): string
  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(optional): string
  Title: Location

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• ShipToLocationId(optional): integer(int64)
  Value that uniquely identifies the location where the supplier ships the item.
• ShipToOrganization(optional): string
  Title: Ship-to Organization

  Maximum Length: 240

  Name of the inventory organization that receives the item.
• ShipToOrganizationCode(optional): string
  Maximum Length: 18

  Abbreviation that identifies the inventory organization where the supplier ships the item.
• ShipToOrganizationId(optional): integer(int64)
  Value that uniquely identifies the inventory organization where the supplier ships the item.
• Status(optional): string
  Title: Status

  Maximum Length: 80

  Status of the purchase order schedule.
• StatusCode(optional): string
  Title: Status

  Maximum Length: 25

  Abbreviation that identifies the status of the purchase order schedule.
• Total(optional): number
  Title: Total

  Ordered amount plus the exclusive tax amounts of the purchase order schedule.
• TotalTax(optional): number
  Title: Total Tax

  Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order.
• Type(optional): string
  Title: Type

  Maximum Length: 80

  Type of payment whether it is released based on units of work or lump sum.
• TypeCode(optional): string
  Maximum Length: 30

  Abbreviation that identifies the schedule type.
• UOM(optional): string
  Title: UOM

  Maximum Length: 25

  Unit of measure in the item quantity.
• UOMCode(optional): string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.
• WorkOrderId(optional): integer(int64)
  Value that uniquely identifies the work order in the factory.
• WorkOrderNumber(optional): string
  Maximum Length: 120

  Display number that uniquely identifies the work order in the factory.
• WorkOrderOperationSequence(optional): number
  Sequence to use when performing each work order operation.

{
    "type":"object",
    "properties":{
        "AccrueAtReceiptFlag":{
            "title":"Accrue at Receipt",
            "description":"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.",
            "type":"boolean"
        },
        "AllowSubstituteReceiptsFlag":{
            "title":"Allow Substitute Receipts",
            "description":"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.",
            "type":"boolean"
        },
        "BackToBackFlag":{
            "title":"Back-to-Back Order",
            "description":"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.",
            "type":"boolean"
        },
        "Carrier":{
            "title":"Carrier",
            "description":"Company that transports the item.",
            "type":"string",
            "maxLength":360
        },
        "CarrierId":{
            "description":"Value that uniquely identifies the company that transports the item.",
            "type":"integer",
            "format":"int64"
        },
        "CountryOfOrigin":{
            "title":"Country of Origin",
            "description":"Country where the organization that ships and exports the item resides.",
            "type":"string",
            "maxLength":80
        },
        "CountryOfOriginCode":{
            "title":"Country of Origin",
            "description":"Abbreviation that identifies the country where the organization resides that ships and exports the item.",
            "type":"string",
            "maxLength":2
        },
        "CreatedBy":{
            "description":"User who created the purchase order schedule.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"Date and time when the buyer or application created the purchase order schedule.",
            "type":"string",
            "format":"date-time"
        },
        "Currency":{
            "title":"Currency",
            "description":"Purchase order currency.",
            "type":"string",
            "maxLength":80
        },
        "CurrencyCode":{
            "description":"Abbreviation that identifies the purchase order currency.",
            "type":"string",
            "maxLength":15
        },
        "DFF":{
            "title":"Flexfields for Purchase Orders",
            "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-DFF-item"
            }
        },
        "Description":{
            "title":"Description",
            "description":"Description of the work associated with the progress payment schedule.",
            "type":"string",
            "maxLength":240
        },
        "DestinationType":{
            "title":"Destination Type",
            "description":"Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order.",
            "type":"string",
            "maxLength":80
        },
        "DestinationTypeCode":{
            "title":"Destination Type",
            "description":"How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING.",
            "type":"string",
            "maxLength":25
        },
        "EarlyReceiptToleranceDays":{
            "description":"Maximum number of days the application allows to receive an early shipment.",
            "type":"number"
        },
        "InvoiceCloseTolerancePercent":{
            "title":"Invoice Close Tolerance Percent",
            "description":"Percent that the application uses to determine whether to close a purchase order schedule when the invoice invoices only part of the item.",
            "type":"number"
        },
        "InvoiceMatchOption":{
            "title":"Invoice Match Option",
            "description":"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.",
            "type":"string",
            "maxLength":80
        },
        "InvoiceMatchOptionCode":{
            "title":"Invoice Match Option",
            "description":"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.",
            "type":"string",
            "maxLength":25
        },
        "LastAcceptDate":{
            "description":"Last date when the receiver can receive the item.",
            "type":"string",
            "format":"date"
        },
        "LastAcceptableDeliveryDate":{
            "title":"Last Acceptable Delivery Date",
            "description":"Last date when the shipper can deliver the item.",
            "type":"string",
            "format":"date"
        },
        "LastAcceptableShipDate":{
            "title":"Last Acceptable Ship Date",
            "description":"Last date when the shipper can ship the item.",
            "type":"string",
            "format":"date"
        },
        "LastUpdateDate":{
            "description":"Date and time when the buyer or application most recently updated the purchase order schedule.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"User who most recently updated the purchase order schedule.",
            "type":"string",
            "maxLength":64
        },
        "LateReceiptToleranceDays":{
            "description":"Maximum number of days the application allows to receive a late shipment.",
            "type":"number"
        },
        "LineLocationId":{
            "description":"Value that uniquely identifies the purchase order schedule.",
            "type":"integer",
            "format":"int64"
        },
        "LineNumber":{
            "title":"Line",
            "description":"Number that uniquely identifies the purchase order line.",
            "type":"number"
        },
        "MatchApprovalLevelCode":{
            "description":"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.",
            "type":"string"
        },
        "ModeOfTransport":{
            "title":"Mode of Transport",
            "description":"Mode of transportation that ships the item, such as truck, air, or boat.",
            "type":"string",
            "maxLength":80
        },
        "ModeOfTransportCode":{
            "description":"Abbreviation that identifies the mode of transport.",
            "type":"string",
            "maxLength":30
        },
        "NoteToReceiver":{
            "title":"Note to Receiver",
            "description":"Note that the receiver can read to get details about how to process the purchase order schedule.",
            "type":"string",
            "maxLength":1000
        },
        "OrchestrationAgreementLineNumber":{
            "description":"Number that identifies the orchestration agreement line.",
            "type":"integer",
            "format":"int64"
        },
        "OrchestrationAgreementNumber":{
            "title":"Financial Orchestration Flow",
            "description":"Number that identifies the orchestration agreement between the legal entities, business units, and trade organizations establishing a trade relationship.",
            "type":"string",
            "maxLength":100
        },
        "OrderNumber":{
            "title":"Order",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "type":"string",
            "maxLength":30
        },
        "Ordered":{
            "title":"Ordered",
            "description":"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.",
            "type":"number"
        },
        "OriginalPromisedDeliveryDate":{
            "title":"Original Promised Delivery Date",
            "description":"Date when the supplier promises to deliver the item that the buyer ordered.",
            "type":"string",
            "format":"date"
        },
        "OriginalPromisedShipDate":{
            "title":"Original Promised Ship Date",
            "description":"Date when the supplier promises to ship the item that the buyer ordered.",
            "type":"string",
            "format":"date"
        },
        "OverReceiptAction":{
            "title":"Over-receipt Action",
            "description":"Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include None, Reject, or Warning.",
            "type":"string",
            "maxLength":80
        },
        "OverReceiptActionCode":{
            "description":"Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include NONE, REJECT, or WARNING.",
            "type":"string",
            "maxLength":25
        },
        "OverReceiptTolerancePercent":{
            "title":"Over-receipt Tolerance Percent",
            "description":"Percent tolerance to use when receiving more than the ordered quantity or amount without starting the action that the OverReceiptActionCode attribute specifies.",
            "type":"number"
        },
        "POHeaderId":{
            "description":"Value that uniquely identifies the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "POLineId":{
            "description":"Value that uniquely identifies the parent of the purchase order line.",
            "type":"integer",
            "format":"int64"
        },
        "POTradingOrganization":{
            "description":"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.",
            "type":"string"
        },
        "POTradingOrganizationCode":{
            "description":"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.",
            "type":"string"
        },
        "POTradingOrganizationId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "Price":{
            "title":"Price",
            "description":"Price of the purchase order line.",
            "type":"number"
        },
        "PricingUOM":{
            "title":"Pricing UOM",
            "description":"Abbreviation that identifies the unit of measure the item uses for pricing.",
            "type":"string",
            "maxLength":25
        },
        "PricingUOMCode":{
            "description":"Unit of measure that the item uses for pricing.",
            "type":"string",
            "maxLength":3
        },
        "PrimaryTradeRelationshipId":{
            "description":"Value that uniquely identifies the primary trade relationship in an orchestration agreement.",
            "type":"integer",
            "format":"int64"
        },
        "PromisedDeliveryDate":{
            "title":"Promised Delivery Date",
            "description":"Date when the supplier promises to deliver the item to the buyer.",
            "type":"string",
            "format":"date"
        },
        "PromisedShipDate":{
            "title":"Promised Ship Date",
            "description":"Date when the supplier promises to ship the item to the buyer.",
            "type":"string",
            "format":"date"
        },
        "Quantity":{
            "title":"Quantity",
            "description":"Scheduled quantity of the item.",
            "type":"number"
        },
        "ReceiptCloseTolerancePercent":{
            "title":"Receipt Close Tolerance Percent",
            "description":"Percent that the application uses to determine whether to close a purchase order schedule when the receiver receives only part of the item.",
            "type":"number"
        },
        "ReceiptDateExceptionAction":{
            "title":"Receipt Date Exception Action",
            "description":"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.",
            "type":"string",
            "maxLength":80
        },
        "ReceiptDateExceptionActionCode":{
            "title":"Receipt Date Exception Action",
            "description":"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.",
            "type":"string",
            "maxLength":25
        },
        "ReceiptRouting":{
            "title":"Receipt Routing",
            "description":"Routing to use when receiving the item. Values include Standard Receipt, Inspection Required, or Direct Delivery.",
            "type":"string",
            "maxLength":80
        },
        "ReceiptRoutingId":{
            "description":"How to simplify transaction entry when routing the receipt. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.",
            "type":"integer",
            "format":"int64"
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "description":"Date when the buyer requests that the supplier deliver the item.",
            "type":"string",
            "format":"date"
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "description":"Date when the buyer requests that the supplier ship the item.",
            "type":"string",
            "format":"date"
        },
        "RetainageAmount":{
            "title":"Retainage",
            "description":"Total amount withheld as retainage against the schedule.",
            "type":"number"
        },
        "RetainageRate":{
            "title":"Retainage Rate",
            "description":"Percentage of the invoice value that can be withheld as retainage.",
            "type":"number"
        },
        "RetainageReleasedAmount":{
            "title":"Retainage Released",
            "description":"Amount of retainage released for the schedule.",
            "type":"number"
        },
        "SalesOrderNumber":{
            "title":"Customer Sales Order",
            "description":"Number that uniquely identifies the sales order that the purchase order schedule references.",
            "type":"string",
            "maxLength":50
        },
        "ScheduleNumber":{
            "title":"Schedule",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "type":"number"
        },
        "SecondaryQuantity":{
            "title":"Secondary Quantity",
            "description":"Scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.",
            "type":"number"
        },
        "SecondaryUOM":{
            "title":"Secondary UOM",
            "description":"Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.",
            "type":"string",
            "maxLength":25
        },
        "SecondaryUOMCode":{
            "description":"Abbreviation that identifies the scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.",
            "type":"string",
            "maxLength":3
        },
        "ShipToCustomer":{
            "title":"Ship-to Party",
            "description":"Name of the party who receives the item that the supplier ships.",
            "type":"string",
            "maxLength":360
        },
        "ShipToCustomerId":{
            "description":"Value that uniquely identifies the third party that receives the item.",
            "type":"integer",
            "format":"int64"
        },
        "ShipToExceptionAction":{
            "title":"Ship-to Exception Action",
            "description":"Action to take if an exception occurs when the receiving location is different from the ship-to location. Values include None, Reject, and Warning.",
            "type":"string",
            "maxLength":80
        },
        "ShipToExceptionActionCode":{
            "description":"How to handle each receipt when the receiving location is different from the ship-to location. Values include NONE, REJECT, or WARNING.",
            "type":"string",
            "maxLength":25
        },
        "ShipToLocationCode":{
            "title":"Location",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "type":"string",
            "maxLength":60
        },
        "ShipToLocationId":{
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "type":"integer",
            "format":"int64"
        },
        "ShipToOrganization":{
            "title":"Ship-to Organization",
            "description":"Name of the inventory organization that receives the item.",
            "type":"string",
            "maxLength":240
        },
        "ShipToOrganizationCode":{
            "description":"Abbreviation that identifies the inventory organization where the supplier ships the item.",
            "type":"string",
            "maxLength":18
        },
        "ShipToOrganizationId":{
            "description":"Value that uniquely identifies the inventory organization where the supplier ships the item.",
            "type":"integer",
            "format":"int64"
        },
        "Status":{
            "title":"Status",
            "description":"Status of the purchase order schedule.",
            "type":"string",
            "maxLength":80
        },
        "StatusCode":{
            "title":"Status",
            "description":"Abbreviation that identifies the status of the purchase order schedule.",
            "type":"string",
            "maxLength":25
        },
        "Total":{
            "title":"Total",
            "description":"Ordered amount plus the exclusive tax amounts of the purchase order schedule.",
            "type":"number"
        },
        "TotalTax":{
            "title":"Total Tax",
            "description":"Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order.",
            "type":"number"
        },
        "Type":{
            "title":"Type",
            "description":"Type of payment whether it is released based on units of work or lump sum.",
            "type":"string",
            "maxLength":80
        },
        "TypeCode":{
            "description":"Abbreviation that identifies the schedule type.",
            "type":"string",
            "maxLength":30
        },
        "UOM":{
            "title":"UOM",
            "description":"Unit of measure in the item quantity.",
            "type":"string",
            "maxLength":25
        },
        "UOMCode":{
            "description":"Abbreviation that identifies the unit of measure.",
            "type":"string",
            "maxLength":3
        },
        "WorkOrderId":{
            "description":"Value that uniquely identifies the work order in the factory.",
            "type":"integer",
            "format":"int64"
        },
        "WorkOrderNumber":{
            "description":"Display number that uniquely identifies the work order in the factory.",
            "type":"string",
            "maxLength":120
        },
        "WorkOrderOperationSequence":{
            "description":"Sequence to use when performing each work order operation.",
            "type":"number"
        },
        "attachments":{
            "title":"Attachments for Purchase Orders",
            "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-attachments-item"
            }
        },
        "distributions":{
            "title":"Distributions",
            "description":"The Distributions resource manages purchasing details, such as details about accounting or the project.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-item"
            }
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

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

• Array of: object purchaseOrders-lines-schedules-attachments-item

{
    "title":"Attachments for Purchase Orders",
    "description":"The Attachments for Purchase Orders resource manage attachments for a purchase order.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-attachments-item"
    }
}

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

• Array of: object purchaseOrders-lines-schedules-DFF-item
  Discriminator: __FLEX_Context

{
    "title":"Flexfields for Purchase Orders",
    "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-DFF-item"
    }
}

Nested Schema : Distributions

Type: array

Title: Distributions

The Distributions resource manages purchasing details, such as details about accounting or the project.

Show Source

• Array of: object purchaseOrders-lines-schedules-distributions-item

{
    "title":"Distributions",
    "description":"The Distributions resource manages purchasing details, such as details about accounting or the project.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-schedules-attachments-item

Type: object

Show Source

• AsyncTrackerId(optional): string
  Title: Asynchronous Upload Tracker Id

  An identifier used for tracking the uploaded files.
• AttachedDocumentId(optional): 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(optional): string
  Title: Category

  Maximum Length: 30

  Category of the attached document.
• ContentRepositoryFileShared(optional): boolean
  Title: Shared

  Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 255

  User who created the attached document.
• CreatedByUserName(optional): string
  Title: Created By User Name

  Login that the user used when creating the document that is attached to the purchase order.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  Date when the user created the attached document.
• DatatypeCode(optional): string
  Title: Type

  Maximum Length: 30

  Abbreviation that identifies the data type.
• Description(optional): string
  Title: Description

  Maximum Length: 255

  Description of the attached document.
• DmDocumentId(optional): string
  Maximum Length: 255

  Value that uniquely identifies the attached document.
• DmFolderPath(optional): string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attached document.
• DmVersionNumber(optional): string
  Maximum Length: 255

  Number that identifies the version of the attached document.
• DownloadInfo(optional): string
  Title: DownloadInfo

  JSON-formatted string that contains information required to programmatically retrieve a large file attachment.
• ErrorStatusCode(optional): string
  Title: Error Status Code

  Abbreviation that identifies the error code, if any, for the attached document.
• ErrorStatusMessage(optional): string
  Title: Error Status Message

  Text of the error message, if any, for the attached document.
• ExpirationDate(optional): string(date-time)
  Title: Expiration Date

  Date when the content in the attached document expires.
• FileContents(optional): string(binary)
  Title: File Contents

  Contents of the attached document.
• FileName(optional): string
  Title: File Name

  Maximum Length: 2048

  File name of the attached document.
• FileUrl(optional): string
  Title: File Url

  URL (Uniform Resource Locator) of the attached document.
• FileWebImage(optional): string(binary)
  Title: File Web Image

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate(optional): string(date-time)
  Title: Last Update Date

  Date and time when the user most recently updated the document that is attached to the purchase order.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 255

  User who most recently updated the document that is attached to the purchase order.
• LastUpdatedByUserName(optional): string
  Title: Last Updated By User

  Login that the user used when updating the document that is attached to the purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• Title(optional): string
  Title: Title

  Title of the attached document.
• UploadedFileContentType(optional): string
  Title: Uploaded File Content Type

  Content type of the attached document.
• UploadedFileLength(optional): integer(int64)
  Title: File Size

  Length of the attached document.
• UploadedFileName(optional): string
  Title: Uploaded File Name

  Name of the attached document.
• UploadedText(optional): string
  Title: Uploaded Text

  Text of the attached document.
• Uri(optional): string
  Title: Uri

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• Url(optional): string
  Title: Url

  Maximum Length: 4000

  URI (Uniform Resource Identifier) that identifies the attached document.
• UserName(optional): string
  Title: User Name

  Maximum Length: 255

  Login that the user used when adding or modifying the attached document.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "description":"An identifier used for tracking the uploaded files.",
            "type":"string"
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "CategoryName":{
            "title":"Category",
            "description":"Category of the attached document.",
            "type":"string",
            "maxLength":30
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "description":"Contains one of the following values: true or false. If true, then the attached document is shared. If false, then the attached document is not shared. The default value is false.",
            "type":"boolean"
        },
        "CreatedBy":{
            "title":"Created By",
            "description":"User who created the attached document.",
            "type":"string",
            "maxLength":255
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "description":"Login that the user used when creating the document that is attached to the purchase order.",
            "type":"string"
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"Date when the user created the attached document.",
            "type":"string",
            "format":"date-time"
        },
        "DatatypeCode":{
            "title":"Type",
            "description":"Abbreviation that identifies the data type.",
            "type":"string",
            "maxLength":30
        },
        "Description":{
            "title":"Description",
            "description":"Description of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmDocumentId":{
            "description":"Value that uniquely identifies the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "description":"Folder path of the attached document.",
            "type":"string",
            "maxLength":1000
        },
        "DmVersionNumber":{
            "description":"Number that identifies the version of the attached document.",
            "type":"string",
            "maxLength":255
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large file attachment.",
            "type":"string"
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "description":"Abbreviation that identifies the error code, if any, for the attached document.",
            "type":"string"
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "description":"Text of the error message, if any, for the attached document.",
            "type":"string"
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "description":"Date when the content in the attached document expires.",
            "type":"string",
            "format":"date-time"
        },
        "FileContents":{
            "title":"File Contents",
            "description":"Contents of the attached document.",
            "type":"string",
            "format":"binary"
        },
        "FileName":{
            "title":"File Name",
            "description":"File name of the attached document.",
            "type":"string",
            "maxLength":2048
        },
        "FileUrl":{
            "title":"File Url",
            "description":"URL (Uniform Resource Locator) of the attached document.",
            "type":"string"
        },
        "FileWebImage":{
            "title":"File Web Image",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "type":"string",
            "format":"binary"
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "description":"Date and time when the user most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "description":"User who most recently updated the document that is attached to the purchase order.",
            "type":"string",
            "maxLength":255
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "description":"Login that the user used when updating the document that is attached to the purchase order.",
            "type":"string"
        },
        "Title":{
            "title":"Title",
            "description":"Title of the attached document.",
            "type":"string"
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "description":"Content type of the attached document.",
            "type":"string"
        },
        "UploadedFileLength":{
            "title":"File Size",
            "description":"Length of the attached document.",
            "type":"integer",
            "format":"int64"
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "description":"Name of the attached document.",
            "type":"string"
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "description":"Text of the attached document.",
            "type":"string"
        },
        "Uri":{
            "title":"Uri",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "Url":{
            "title":"Url",
            "description":"URI (Uniform Resource Identifier) that identifies the attached document.",
            "type":"string",
            "maxLength":4000
        },
        "UserName":{
            "title":"User Name",
            "description":"Login that the user used when adding or modifying the attached document.",
            "type":"string",
            "maxLength":255
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-schedules-DFF-item

Type: object

Discriminator: __FLEX_Context

Show Source

• __FLEX_Context: string
  Maximum Length: 30

  Descriptive flexfield context name for purchase order.
• _FLEX_NumOfSegments(optional): integer(int32)
  Descriptive flexfield number of segments for purchase order.
• _FLEX_NumOfVisibleSegments(optional): integer(int32)
  Descriptive flexfield number of visible segments for purchase order.
• _FLEX_ValidationDate(optional): string(date)
  Descriptive flexfield validation date for purchase order.
• LineLocationId(optional): integer(int64)
  Value that uniquely identifies the purchase order schedule.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "type":"object",
    "properties":{
        "LineLocationId":{
            "description":"Value that uniquely identifies the purchase order schedule.",
            "type":"integer",
            "format":"int64"
        },
        "_FLEX_NumOfSegments":{
            "description":"Descriptive flexfield number of segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_NumOfVisibleSegments":{
            "description":"Descriptive flexfield number of visible segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_ValidationDate":{
            "description":"Descriptive flexfield validation date for purchase order.",
            "type":"string",
            "format":"date"
        },
        "__FLEX_Context":{
            "description":"Descriptive flexfield context name for purchase order.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "__FLEX_Context"
    ],
    "discriminator":"__FLEX_Context"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-schedules-distributions-item

Type: object

Show Source

• BudgetDate(optional): string(date)
  Title: Budget Date

  Date to use to determine the timeframe when the organization consumed the budget.
• ConversionRate(optional): number
  Title: Conversion Rate

  Conversion rate to use when converting the currency.
• ConversionRateDate(optional): 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(optional): string
  Maximum Length: 64

  User who created the purchase order distribution.
• CreationDate(optional): string(date-time)
  Date and time when the buyer or application created the purchase order distribution.
• Currency(optional): string
  Title: Currency

  Maximum Length: 80

  Purchase order currency.
• CurrencyCode(optional): string
  Maximum Length: 15

  Abbreviation that identifies the purchase order currency.
• DeliverToCustomer(optional): string
  Maximum Length: 360

  Name of the third-party that receives the item.
• DeliverToCustomerId(optional): integer(int64)
  Value that uniquely identifies the third-party location that receives the item.
• DeliverToCustomerLocation(optional): string
  Name of the customer location that receives the item. Applies during a drop ship.
• DeliverToCustomerLocationId(optional): integer(int64)
  Value that uniquely identifies the third-party location that receives the item.
• DeliverToLocationCode(optional): string
  Title: Deliver-to Location

  Abbreviation that identifies the final location that receives the item.
• DeliverToLocationId(optional): integer(int64)
  Value that uniquely identifies the final location that receives the item.
• DestinationChargeAccount(optional): string
  Title: Destination Charge Account

  Account to charge for the cost of the item in the requisitioning business unit.
• DestinationChargeAccountId(optional): integer(int64)
  Value that uniquely identifies the account to charge for the cost of the item in the requisitioning business unit.
• DestinationSubinventory(optional): string
  Title: Destination Subinventory

  Maximum Length: 10

  Subinventory that identifies where to deliver the requested item.
• DestinationVarianceAccount(optional): string
  Title: Destination Variance Account

  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(optional): 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(optional): array Flexfields for Purchase Orders
  Title: Flexfields for Purchase Orders

  The Flexfields for Purchase Orders resource manages additional details about purchase orders.
• DistributionNumber(optional): number
  Title: Distribution

  Number that uniquely identifies the purchase order distribution for the purchase order schedule.
• LastUpdateDate(optional): string(date-time)
  Date and time when the buyer or application most recently updated the purchase order distribution.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  User who most recently updated the purchase order distribution.
• LineNumber(optional): number
  Title: Line

  Number that uniquely identifies the purchase order line for the purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• NonrecoverableExclusiveTax(optional): number
  Title: Nonrecoverable Exclusive Tax

  Tax that the purchase order amount does not contain. The purchaser cannot recover this tax.
• NonrecoverableInclusiveTax(optional): number
  Title: Nonrecoverable Inclusive Tax

  Tax that the purchase order amount contains. The purchaser cannot recover this tax.
• Ordered(optional): 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(optional): string
  Title: Order

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• POAccrualAccount(optional): string
  Title: PO Accrual Account

  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(optional): 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(optional): string
  Title: PO Charge Account

  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(optional): 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(optional): integer(int64)
  Value that uniquely identifies the purchase order distribution.
• POHeaderId(optional): integer(int64)
  Value that uniquely identifies the purchase order.
• POLineId(optional): integer(int64)
  Value that uniquely identifies the parent of the purchase order line.
• POVarianceAccount(optional): string
  Title: PO Variance Account

  Account to charge for any price difference between the invoice and the purchase order.
• POVarianceAccountId(optional): integer(int64)
  Value that uniquely identifies the account to charge for the price difference between the invoice and the purchase order.
• projectDFF(optional): 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(optional): number
  Title: Quantity

  Distribution quantity of the item that the purchaser is purchasing.
• RecoverableExclusiveTax(optional): number
  Title: Recoverable Exclusive Tax

  Tax that the purchase order amount does not contain. The purchaser can recover this tax.
• RecoverableInclusiveTax(optional): number
  Title: Recoverable Inclusive Tax

  Tax that the purchase order amount contains. The purchaser can recover this tax.
• Requester(optional): string
  Title: Requester

  Maximum Length: 240

  Name of the deliver-to person or requester.
• RequesterId(optional): integer(int64)
  Value that uniquely identifies the deliver-to person or requester.
• Requisition(optional): string
  Title: Requisition

  Maximum Length: 64

  Number that identifies the requisition.
• RequisitionDistribution(optional): number
  Title: Requisition Distribution

  Number that uniquely identifies a requisition distribution for the requisition line.
• RequisitionDistributionId(optional): integer(int64)
  Value that uniquely identifies the requisition distribution.
• RequisitionHeaderId(optional): integer(int64)
  Value that uniquely identifies the requisition header.
• RequisitionLine(optional): number
  Title: Requisition Line

  Number that uniquely identifies the requisition line for the requisition.
• RequisitionLineId(optional): integer(int64)
  Value that uniquely identifies the requisition line.
• ScheduleNumber(optional): number
  Title: Schedule

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• Total(optional): number
  Title: Total

  Ordered amount plus the exclusive tax amounts of the purchase order distribution.
• TotalTax(optional): number
  Title: Total Tax

  Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order distribution.
• UOM(optional): string
  Title: UOM

  Maximum Length: 25

  Unit of measure of the item quantity.
• UOMCode(optional): string
  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "BudgetDate":{
            "title":"Budget Date",
            "description":"Date to use to determine the timeframe when the organization consumed the budget.",
            "type":"string",
            "format":"date"
        },
        "ConversionRate":{
            "title":"Conversion Rate",
            "description":"Conversion rate to use when converting the currency.",
            "type":"number"
        },
        "ConversionRateDate":{
            "title":"Conversion Date",
            "description":"Date to use for the conversion rate when converting an amount into another currency. The conversion rate varies depending on date.",
            "type":"string",
            "format":"date"
        },
        "CreatedBy":{
            "description":"User who created the purchase order distribution.",
            "type":"string",
            "maxLength":64
        },
        "CreationDate":{
            "description":"Date and time when the buyer or application created the purchase order distribution.",
            "type":"string",
            "format":"date-time"
        },
        "Currency":{
            "title":"Currency",
            "description":"Purchase order currency.",
            "type":"string",
            "maxLength":80
        },
        "CurrencyCode":{
            "description":"Abbreviation that identifies the purchase order currency.",
            "type":"string",
            "maxLength":15
        },
        "DFF":{
            "title":"Flexfields for Purchase Orders",
            "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-DFF-item"
            }
        },
        "DeliverToCustomer":{
            "description":"Name of the third-party that receives the item.",
            "type":"string",
            "maxLength":360
        },
        "DeliverToCustomerId":{
            "description":"Value that uniquely identifies the third-party location that receives the item.",
            "type":"integer",
            "format":"int64"
        },
        "DeliverToCustomerLocation":{
            "description":"Name of the customer location that receives the item. Applies during a drop ship.",
            "type":"string"
        },
        "DeliverToCustomerLocationId":{
            "description":"Value that uniquely identifies the third-party location that receives the item.",
            "type":"integer",
            "format":"int64"
        },
        "DeliverToLocationCode":{
            "title":"Deliver-to Location",
            "description":"Abbreviation that identifies the final location that receives the item.",
            "type":"string"
        },
        "DeliverToLocationId":{
            "description":"Value that uniquely identifies the final location that receives the item.",
            "type":"integer",
            "format":"int64"
        },
        "DestinationChargeAccount":{
            "title":"Destination Charge Account",
            "description":"Account to charge for the cost of the item in the requisitioning business unit.",
            "type":"string"
        },
        "DestinationChargeAccountId":{
            "description":"Value that uniquely identifies the account to charge for the cost of the item in the requisitioning business unit.",
            "type":"integer",
            "format":"int64"
        },
        "DestinationSubinventory":{
            "title":"Destination Subinventory",
            "description":"Subinventory that identifies where to deliver the requested item.",
            "type":"string",
            "maxLength":10
        },
        "DestinationVarianceAccount":{
            "title":"Destination Variance Account",
            "description":"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.",
            "type":"string"
        },
        "DestinationVarianceAccountId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "DistributionNumber":{
            "title":"Distribution",
            "description":"Number that uniquely identifies the purchase order distribution for the purchase order schedule.",
            "type":"number"
        },
        "LastUpdateDate":{
            "description":"Date and time when the buyer or application most recently updated the purchase order distribution.",
            "type":"string",
            "format":"date-time"
        },
        "LastUpdatedBy":{
            "description":"User who most recently updated the purchase order distribution.",
            "type":"string",
            "maxLength":64
        },
        "LineNumber":{
            "title":"Line",
            "description":"Number that uniquely identifies the purchase order line for the purchase order.",
            "type":"number"
        },
        "NonrecoverableExclusiveTax":{
            "title":"Nonrecoverable Exclusive Tax",
            "description":"Tax that the purchase order amount does not contain. The purchaser cannot recover this tax.",
            "type":"number"
        },
        "NonrecoverableInclusiveTax":{
            "title":"Nonrecoverable Inclusive Tax",
            "description":"Tax that the purchase order amount contains. The purchaser cannot recover this tax.",
            "type":"number"
        },
        "OrderNumber":{
            "title":"Order",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "type":"string",
            "maxLength":30
        },
        "Ordered":{
            "title":"Ordered",
            "description":"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.",
            "type":"number"
        },
        "POAccrualAccount":{
            "title":"PO Accrual Account",
            "description":"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.",
            "type":"string"
        },
        "POAccrualAccountId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "POChargeAccount":{
            "title":"PO Charge Account",
            "description":"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.",
            "type":"string"
        },
        "POChargeAccountId":{
            "description":"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.",
            "type":"integer",
            "format":"int64"
        },
        "PODistributionId":{
            "description":"Value that uniquely identifies the purchase order distribution.",
            "type":"integer",
            "format":"int64"
        },
        "POHeaderId":{
            "description":"Value that uniquely identifies the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "POLineId":{
            "description":"Value that uniquely identifies the parent of the purchase order line.",
            "type":"integer",
            "format":"int64"
        },
        "POVarianceAccount":{
            "title":"PO Variance Account",
            "description":"Account to charge for any price difference between the invoice and the purchase order.",
            "type":"string"
        },
        "POVarianceAccountId":{
            "description":"Value that uniquely identifies the account to charge for the price difference between the invoice and the purchase order.",
            "type":"integer",
            "format":"int64"
        },
        "Quantity":{
            "title":"Quantity",
            "description":"Distribution quantity of the item that the purchaser is purchasing.",
            "type":"number"
        },
        "RecoverableExclusiveTax":{
            "title":"Recoverable Exclusive Tax",
            "description":"Tax that the purchase order amount does not contain. The purchaser can recover this tax.",
            "type":"number"
        },
        "RecoverableInclusiveTax":{
            "title":"Recoverable Inclusive Tax",
            "description":"Tax that the purchase order amount contains. The purchaser can recover this tax.",
            "type":"number"
        },
        "Requester":{
            "title":"Requester",
            "description":"Name of the deliver-to person or requester.",
            "type":"string",
            "maxLength":240
        },
        "RequesterId":{
            "description":"Value that uniquely identifies the deliver-to person or requester.",
            "type":"integer",
            "format":"int64"
        },
        "Requisition":{
            "title":"Requisition",
            "description":"Number that identifies the requisition.",
            "type":"string",
            "maxLength":64
        },
        "RequisitionDistribution":{
            "title":"Requisition Distribution",
            "description":"Number that uniquely identifies a requisition distribution for the requisition line.",
            "type":"number"
        },
        "RequisitionDistributionId":{
            "description":"Value that uniquely identifies the requisition distribution.",
            "type":"integer",
            "format":"int64"
        },
        "RequisitionHeaderId":{
            "description":"Value that uniquely identifies the requisition header.",
            "type":"integer",
            "format":"int64"
        },
        "RequisitionLine":{
            "title":"Requisition Line",
            "description":"Number that uniquely identifies the requisition line for the requisition.",
            "type":"number"
        },
        "RequisitionLineId":{
            "description":"Value that uniquely identifies the requisition line.",
            "type":"integer",
            "format":"int64"
        },
        "ScheduleNumber":{
            "title":"Schedule",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "type":"number"
        },
        "Total":{
            "title":"Total",
            "description":"Ordered amount plus the exclusive tax amounts of the purchase order distribution.",
            "type":"number"
        },
        "TotalTax":{
            "title":"Total Tax",
            "description":"Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order distribution.",
            "type":"number"
        },
        "UOM":{
            "title":"UOM",
            "description":"Unit of measure of the item quantity.",
            "type":"string",
            "maxLength":25
        },
        "UOMCode":{
            "description":"Abbreviation that identifies the unit of measure.",
            "type":"string",
            "maxLength":3
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        },
        "projectDFF":{
            "title":"Project Costing Flexfields for Distributions",
            "description":"The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-projectDFF-item"
            }
        }
    }
}

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

• Array of: object purchaseOrders-lines-schedules-distributions-DFF-item
  Discriminator: __FLEX_Context

{
    "title":"Flexfields for Purchase Orders",
    "description":"The Flexfields for Purchase Orders resource manages additional details about purchase orders.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-DFF-item"
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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

• Array of: object purchaseOrders-lines-schedules-distributions-projectDFF-item
  Discriminator: __FLEX_Context

{
    "title":"Project Costing Flexfields for Distributions",
    "description":"The Project Costing Flexfields for Distributions resource manages project details about purchase order distributions.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/purchaseOrders-lines-schedules-distributions-projectDFF-item"
    }
}

Nested Schema : purchaseOrders-lines-schedules-distributions-DFF-item

Type: object

Discriminator: __FLEX_Context

Show Source

• __FLEX_Context: string
  Maximum Length: 30

  Descriptive flexfield context name for purchase order.
• _FLEX_NumOfSegments(optional): integer(int32)
  Descriptive flexfield number of segments for purchase order.
• _FLEX_NumOfVisibleSegments(optional): integer(int32)
  Descriptive flexfield number of visible segments for purchase order.
• _FLEX_ValidationDate(optional): string(date)
  Descriptive flexfield validation date for purchase order.
• links(optional): array Items
  Title: Items

  Link Relations
• PoDistributionId(optional): integer(int64)
  Value that uniquely identifies the purchase order distribution.

{
    "type":"object",
    "properties":{
        "PoDistributionId":{
            "description":"Value that uniquely identifies the purchase order distribution.",
            "type":"integer",
            "format":"int64"
        },
        "_FLEX_NumOfSegments":{
            "description":"Descriptive flexfield number of segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_NumOfVisibleSegments":{
            "description":"Descriptive flexfield number of visible segments for purchase order.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_ValidationDate":{
            "description":"Descriptive flexfield validation date for purchase order.",
            "type":"string",
            "format":"date"
        },
        "__FLEX_Context":{
            "description":"Descriptive flexfield context name for purchase order.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "__FLEX_Context"
    ],
    "discriminator":"__FLEX_Context"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : purchaseOrders-lines-schedules-distributions-projectDFF-item

Type: object

Discriminator: __FLEX_Context

Show Source

• __FLEX_Context: string
  Maximum Length: 40

  Project costing descriptive flexfield context name for purchase order distributions.
• _FLEX_NumOfSegments(optional): integer(int32)
  Project costing descriptive flexfield number of segments for purchase order distributions.
• _FLEX_NumOfVisibleSegments(optional): integer(int32)
  Project costing descriptive flexfield number of visible segments for purchase order distributions.
• _FLEX_ValidationDate(optional): string(date)
  Project costing descriptive flexfield validation date for purchase order distributions.
• links(optional): array Items
  Title: Items

  Link Relations
• PoDistributionId(optional): integer(int64)
  Value that uniquely identifies the purchase order distribution.

{
    "type":"object",
    "properties":{
        "PoDistributionId":{
            "description":"Value that uniquely identifies the purchase order distribution.",
            "type":"integer",
            "format":"int64"
        },
        "_FLEX_NumOfSegments":{
            "description":"Project costing descriptive flexfield number of segments for purchase order distributions.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_NumOfVisibleSegments":{
            "description":"Project costing descriptive flexfield number of visible segments for purchase order distributions.",
            "type":"integer",
            "format":"int32"
        },
        "_FLEX_ValidationDate":{
            "description":"Project costing descriptive flexfield validation date for purchase order distributions.",
            "type":"string",
            "format":"date"
        },
        "__FLEX_Context":{
            "description":"Project costing descriptive flexfield context name for purchase order distributions.",
            "type":"string",
            "maxLength":40
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    },
    "required":[
        "__FLEX_Context"
    ],
    "discriminator":"__FLEX_Context"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

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