Jump to

• Request
• Response

Get all action not supported

get

/fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds purchase order life cycle details according to the primary key.
    Finder Variables
    • POHeaderId; integer; Value that uniquely identifies the purchase order.
  • findByIntent Finds purchase order life cycle details according to intent.
    Finder Variables
    • Intent; string; Value that identifies the intent for accessing the Purchase Order Lifecycle Details resource. Valid values are APUser, POUser, LOBUser, SSPUser and NonAgentUser.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • OrderNumber; string; Number that uniquely identifies the purchase order in the sold-to legal entity.
  • POHeaderId; integer; Value that uniquely identifies the purchase order.
• 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".

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : purchaseOrderLifeCycleDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object purchaseOrderLifeCycleDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseOrderLifeCycleDetails-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase order currency.
• DeliveredAmount: number
  Read Only: true

  Value of the goods and services delivered to the buying organization.
• InReceivingAmount: number
  Read Only: true

  Value of the goods received by the buying organization, currently in receiving, not delivered or returned.
• InTransitAmount: number
  Read Only: true

  Value of goods shipped by the supplier, but yet to be received at the buying organization.
• invoices: array Invoices
  Title: Invoices

  The details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderedAmount: number
  Read Only: true

  Total amount of the order according to the quantities and prices of the goods and service items specified on the order.
• OrderNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• PaidAmount: number
  Read Only: true

  Invoiced amount that has been paid.
• PartiallyPaidAmount: number
  Read Only: true

  Invoiced amount that has been partially paid.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order.
• receipts: array Receipts
  Title: Receipts

  The details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received.
• schedules: array Schedules
  Title: Schedules

  The details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced.
• shipments: array Shipments
  Title: Shipments

  The details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments.
• UnpaidAmount: number
  Read Only: true

  Invoiced amount that hasn't been paid.

{
    "type":"object",
    "properties":{
        "UnpaidAmount":{
            "type":"number",
            "description":"Invoiced amount that hasn't been paid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order in the sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "shipments":{
            "title":"Shipments",
            "type":"array",
            "description":"The details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-shipments-item-response"
            }
        },
        "PaidAmount":{
            "type":"number",
            "description":"Invoiced amount that has been paid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InReceivingAmount":{
            "type":"number",
            "description":"Value of the goods received by the buying organization, currently in receiving, not delivered or returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "receipts":{
            "title":"Receipts",
            "type":"array",
            "description":"The details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-receipts-item-response"
            }
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Value of the goods and services delivered to the buying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PartiallyPaidAmount":{
            "type":"number",
            "description":"Invoiced amount that has been partially paid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "invoices":{
            "title":"Invoices",
            "type":"array",
            "description":"The details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-invoices-item-response"
            }
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "schedules":{
            "title":"Schedules",
            "type":"array",
            "description":"The details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-schedules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrderedAmount":{
            "type":"number",
            "description":"Total amount of the order according to the quantities and prices of the goods and service items specified on the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InTransitAmount":{
            "type":"number",
            "description":"Value of goods shipped by the supplier, but yet to be received at the buying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Invoices

Type: array

Title: Invoices

The details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts.

Show Source

• Array of: object purchaseOrderLifeCycleDetails-invoices-item-response

{
    "title":"Invoices",
    "type":"array",
    "description":"The details about supplier invoices that are created against purchase orders, such as matched quantities and amounts and total invoice amounts.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-invoices-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : Receipts

Type: array

Title: Receipts

The details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received.

Show Source

• Array of: object purchaseOrderLifeCycleDetails-receipts-item-response

{
    "title":"Receipts",
    "type":"array",
    "description":"The details about receipts and deliveries that are created against purchase orders, such as how many items have been received and when they were received.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-receipts-item-response"
    }
}

Nested Schema : Schedules

Type: array

Title: Schedules

The details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced.

Show Source

• Array of: object purchaseOrderLifeCycleDetails-schedules-item-response

{
    "title":"Schedules",
    "type":"array",
    "description":"The details about the purchase order schedule, such as how many items were requested and ordered, as well information regarding how many of those items were shipped, received, and invoiced.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-schedules-item-response"
    }
}

Nested Schema : Shipments

Type: array

Title: Shipments

The details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments.

Show Source

• Array of: object purchaseOrderLifeCycleDetails-shipments-item-response

{
    "title":"Shipments",
    "type":"array",
    "description":"The details about shipments that are created against purchase orders, such as how many items have been shipped, when they were shipped, and the carrier and tracking numbers for those shipments.",
    "items":{
        "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-shipments-item-response"
    }
}

Nested Schema : purchaseOrderLifeCycleDetails-invoices-item-response

Type: object

Show Source

• ConsumptionAdvice: string
  Read Only: true

  Maximum Length: 20

  Number that identifies the consumption advice associated with the invoice line.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase order currency.
• HoldReasonCode: string
  Read Only: true

  Maximum Length: 4000

  Abbreviation that identifies the reason for the invoice hold.
• Invoice: string
  Title: Invoice

  Read Only: true

  Maximum Length: 50

  Number that identifies the invoice.
• InvoicedDate: string (date)
  Title: Date

  Read Only: true

  Date when the goods or services were invoiced.
• InvoiceId: number
  Read Only: true

  Value that uniquely identifies the invoice.
• InvoiceStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  Status of the invoice.
• InvoiceStatusCode: string
  Read Only: true

  Maximum Length: 14

  Abbreviation that identifies the invoice status.
• InvoiceType: string
  Title: Type

  Read Only: true

  Maximum Length: 50

  Type of the invoice. Contains one of the following values: Prepayment, Credit Memo, Debit Memo or Standard Invoice.
• ItemOrScheduleDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Either the description of the item or the work associated with the progress payment schedule.
• LineDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item that the purchase order references.
• LineLocationId: number
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order line.
• LineNumberScheduleNumber: string
  Title: Line - Schedule

  Read Only: true

  Maximum Length: 81

  Line and schedule number for a purchase order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatchedAmount: number
  Read Only: true

  Invoice amount matched to the purchase order schedule.
• MatchedAmountWithQualifier: string
  Title: Matched Amount

  Read Only: true

  Maximum Length: 255

  Invoice amount matched to the purchase order schedule shown with the currency code.
• MatchedQuantity: number
  Read Only: true

  Invoice quantity matched to the purchase order schedule.
• MatchedQuantityWithQualifier: string
  Title: Matched Quantity

  Read Only: true

  Maximum Length: 255

  Invoice quantity matched to the purchase order schedule shown with the UOM code.
• POHeaderId: number
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: number
  Read Only: true

  Value that uniquely identifies the purchase order line.
• Receipt: string
  Title: Receipt

  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt.
• ReceiptId: number
  Read Only: true

  Value that uniquely identifies the receipt.
• ScheduleDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• ScheduleNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• TotalInvoicedAmount: number
  Read Only: true

  Total amount of an invoice.
• TotalInvoicedAmountWithQualifier: string
  Title: Total Invoiced Amount

  Read Only: true

  Maximum Length: 255

  Total amount of an invoice shown with the currency code.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure that the item uses for quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ScheduleDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Invoice":{
            "title":"Invoice",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceStatusCode":{
            "maxLength":14,
            "type":"string",
            "description":"Abbreviation that identifies the invoice status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "HoldReasonCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the invoice hold.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemOrScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Either the description of the item or the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceId":{
            "type":"number",
            "description":"Value that uniquely identifies the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchedAmount":{
            "type":"number",
            "description":"Invoice amount matched to the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "MatchedQuantityWithQualifier":{
            "title":"Matched Quantity",
            "maxLength":255,
            "type":"string",
            "description":"Invoice quantity matched to the purchase order schedule shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the purchase order references.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "MatchedQuantity":{
            "type":"number",
            "description":"Invoice quantity matched to the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when the goods or services were invoiced.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TotalInvoicedAmountWithQualifier":{
            "title":"Total Invoiced Amount",
            "maxLength":255,
            "type":"string",
            "description":"Total amount of an invoice shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "TotalInvoicedAmount":{
            "type":"number",
            "description":"Total amount of an invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ScheduleNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Receipt":{
            "title":"Receipt",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumberScheduleNumber":{
            "title":"Line - Schedule",
            "maxLength":81,
            "type":"string",
            "description":"Line and schedule number for a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConsumptionAdvice":{
            "maxLength":20,
            "type":"string",
            "description":"Number that identifies the consumption advice associated with the invoice line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoiceType":{
            "title":"Type",
            "maxLength":50,
            "type":"string",
            "description":"Type of the invoice. Contains one of the following values: Prepayment, Credit Memo, Debit Memo or Standard Invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the item uses for quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceiptId":{
            "type":"number",
            "description":"Value that uniquely identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineLocationId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "InvoiceStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "MatchedAmountWithQualifier":{
            "title":"Matched Amount",
            "maxLength":255,
            "type":"string",
            "description":"Invoice amount matched to the purchase order schedule shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : purchaseOrderLifeCycleDetails-receipts-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase order currency.
• DeliveredAmount: number
  Read Only: true

  Amount delivered against the purchase order schedule for the service lines.
• DeliveredQuantity: number
  Read Only: true

  Ordered quantity that has been delivered.
• DeliveredWithQualifier: string
  Title: Delivered

  Read Only: true

  Maximum Length: 255

  Quantity or amount delivered against the purchase order schedule.
• InConsignedInventory: number
  Read Only: true

  Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed.
• InConsignedInventoryWithQualifier: string
  Title: In Consigned Inventory

  Read Only: true

  Maximum Length: 255

  Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. Value shown with UOM code.
• InvoicedAmount: number
  Read Only: true

  Ordered amount that has been invoiced.
• InvoicedQuantity: number
  Read Only: true

  Ordered quantity that has been invoiced.
• InvoicedWithQualifier: string
  Title: Invoiced

  Read Only: true

  Maximum Length: 255

  Quantity or amount invoiced against the purchase order schedule.
• ItemOrScheduleDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Either the description of the item or the work associated with the progress payment schedule.
• LineDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item that the purchase order references.
• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order line.
• LineNumberScheduleNumber: string
  Title: Line - Schedule

  Read Only: true

  Maximum Length: 81

  Line and schedule number for a purchase order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OpenToInvoiceAmount: number
  Read Only: true

  Ordered amount that hasn't been invoiced yet.
• OpenToInvoiceQuantity: number
  Read Only: true

  Ordered quantity that hasn't been invoiced yet.
• OpenToInvoiceWithQualifier: string
  Title: Open to Invoice

  Read Only: true

  Maximum Length: 255

  Quantity or amount that hasn't been invoiced yet.
• POHeaderId: number
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: number
  Read Only: true

  Value that uniquely identifies the purchase order line.
• Receipt: string
  Title: Receipt

  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt.
• ReceiptDate: string (date)
  Title: Date

  Read Only: true

  Date when goods or services were received.
• ReceiptId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt.
• ReceivedAmount: number
  Read Only: true

  Amount received against the purchase order schedule for service lines.
• ReceivedBy: string
  Title: Received By

  Read Only: true

  Maximum Length: 240

  Name of the person who received the goods or services.
• ReceivedInSecondaryQuantity: number
  Read Only: true

  Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item.
• ReceivedInSecondaryQuantityWithQualifier: string
  Title: Received in Secondary

  Read Only: true

  Maximum Length: 255

  Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item shown with the UOM code.
• ReceivedQuantity: number
  Read Only: true

  Ordered quantity that has been received.
• ReceivedWithQualifier: string
  Title: Received

  Read Only: true

  Maximum Length: 255

  Ordered quantity that has been received shown with the UOM code.
• ReturnedQuantity: number
  Read Only: true

  Ordered quantity that has been returned.
• ReturnedWithQualifier: string
  Title: Returned

  Read Only: true

  Maximum Length: 255

  Ordered quantity that has been returned shown with the UOM code.
• ReturnToSupplierType: string
  Title: Return for Credit

  Read Only: true

  Maximum Length: 25

  Type of the return to supplier transaction. Contains one of the following values: Return For Credit or Return For Replacement.
• ScheduleDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• ScheduleNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• SecondaryUOM: string
  Read Only: true

  Maximum Length: 3

  An alternative UOM that's allowed to quantify a dual UOM-controlled item.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item.
• ShipmentId: number
  Read Only: true

  Value that uniquely identifies the shipment.
• ShipmentNumber: string
  Title: Shipment

  Read Only: true

  Maximum Length: 50

  Number that identifies the shipment.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure that the item uses for quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ScheduleDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ReceivedAmount":{
            "type":"number",
            "description":"Amount received against the purchase order schedule for service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipmentId":{
            "type":"number",
            "description":"Value that uniquely identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SecondaryUOM":{
            "maxLength":3,
            "type":"string",
            "description":"An alternative UOM that's allowed to quantify a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShipmentNumber":{
            "title":"Shipment",
            "maxLength":50,
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ItemOrScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Either the description of the item or the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedInSecondaryQuantityWithQualifier":{
            "title":"Received in Secondary",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedWithQualifier":{
            "title":"Received",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been received shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been invoiced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceWithQualifier":{
            "title":"Open to Invoice",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the purchase order references.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReturnedQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "POLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredWithQualifier":{
            "title":"Delivered",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount delivered against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ScheduleNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Receipt":{
            "title":"Receipt",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InConsignedInventory":{
            "type":"number",
            "description":"Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedInSecondaryQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been received in the secondary UOM of a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedWithQualifier":{
            "title":"Invoiced",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount invoiced against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumberScheduleNumber":{
            "title":"Line - Schedule",
            "maxLength":81,
            "type":"string",
            "description":"Line and schedule number for a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been delivered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceAmount":{
            "type":"number",
            "description":"Ordered amount that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedBy":{
            "title":"Received By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person who received the goods or services.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the item uses for quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Amount delivered against the purchase order schedule for the service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceiptId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "ReturnToSupplierType":{
            "title":"Return for Credit",
            "maxLength":25,
            "type":"string",
            "description":"Type of the return to supplier transaction. Contains one of the following values: Return For Credit or Return For Replacement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceQuantity":{
            "type":"number",
            "description":"Ordered quantity that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "ReturnedWithQualifier":{
            "title":"Returned",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been returned shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InConsignedInventoryWithQualifier":{
            "title":"In Consigned Inventory",
            "maxLength":255,
            "type":"string",
            "description":"Denotes the on hand balance of consignment goods delivered into consigned inventory but not yet consumed. Value shown with UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"Ordered amount that has been invoiced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceiptDate":{
            "title":"Date",
            "type":"string",
            "description":"Date when goods or services were received.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseOrderLifeCycleDetails-schedules-item-response

Type: object

Show Source

• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase order currency.
• DeliveredAmount: number
  Read Only: true

  Amount delivered against the purchase order schedule for service lines.
• DeliveredQuantity: number
  Read Only: true

  Ordered quantity or amount that has been delivered.
• DeliveredWithQualifier: string
  Title: Delivered

  Read Only: true

  Maximum Length: 255

  Quantity or amount delivered against the purchase order schedule.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  Date when the goods are requested or promised for delivery.
• HasMultipleReceiptsFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the purchase order schedule has multiple receipts or not. Valid values are true and false.
• InReceivingQuantity: number
  Read Only: true

  Ordered quantity received by the buying organization, currently in receiving, and not delivered, or returned.
• InReceivingQuantityWithQualifier: string
  Title: In Receiving

  Read Only: true

  Maximum Length: 255

  Ordered quantity received by the buying organization, currently in receiving, and not delivered, or returned. Value is shown with UOM code.
• InTransitQuantity: number
  Read Only: true

  Ordered quantity shipped by the supplier, but yet to be received at the buying organization.
• InTransitQuantityWithQualifier: string
  Title: In Transit

  Read Only: true

  Maximum Length: 255

  Ordered quantity shipped by the supplier, but yet to be received at the buying organization. Value is shown with the UOM code.
• InvoicedAmount: number
  Read Only: true

  Ordered amount that has been invoiced.
• InvoicedAmountWithQualifier: string
  Title: Invoiced Amount

  Read Only: true

  Maximum Length: 255

  Ordered amount that has been invoiced shown with the currency code.
• InvoicedQuantity: number
  Read Only: true

  Ordered quantity that has been invoiced.
• InvoicedQuantityWithQualifier: string
  Title: Invoiced Quantity

  Read Only: true

  Maximum Length: 255

  Ordered quantity that has been invoiced shown with the UOM code.
• ItemOrScheduleDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Either the description of the item or the work associated with the progress payment schedule.
• LineDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item that the purchase order references.
• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order line.
• LineNumberScheduleNumber: string
  Title: Line - Schedule

  Read Only: true

  Maximum Length: 81

  Line and schedule number for a purchase order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OpenToInvoiceAmount: number
  Read Only: true

  Ordered amount that hasn't been invoiced yet.
• OpenToInvoiceQuantity: number
  Read Only: true

  Ordered quantity that hasn't been invoiced yet.
• OpenToInvoiceWithQualifier: string
  Title: Open to Invoice

  Read Only: true

  Maximum Length: 255

  Quantity or amount that hasn't been invoiced yet.
• OrderedAmount: number
  Read Only: true

  Total amount ordered for this purchase order schedule.
• OrderedAmountWithQualifier: string
  Title: Ordered Amount

  Read Only: true

  Maximum Length: 255

  Total amount ordered for this purchase order schedule shown with the currency code.
• OrderedInSecondaryQuantity: number
  Read Only: true

  Ordered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item.
• OrderedInSecondaryQuantityWithQualifier: string
  Title: Ordered in Secondary

  Read Only: true

  Maximum Length: 255

  Ordered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code.
• OrderedQuantity: number
  Read Only: true

  Total quantity ordered for this purchase order schedule.
• OrderedQuantityWithQualifier: string
  Title: Ordered Quantity

  Read Only: true

  Maximum Length: 255

  Total quantity ordered for this purchase order schedule shown with the UOM code.
• POHeaderId: number
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: number
  Read Only: true

  Value that uniquely identifies the purchase order line.
• ReceiptDate: string (date)
  Title: Receipt Date

  Read Only: true

  Date when the goods or services were received.
• ReceivedAmount: number
  Read Only: true

  Ordered amount that has been received.
• ReceivedInSecondaryQuantity: number
  Read Only: true

  Ordered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item.
• ReceivedInSecondaryQuantityWithQualifier: string
  Title: Received in Secondary

  Read Only: true

  Maximum Length: 255

  Ordered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code.
• ReceivedQuantity: number
  Read Only: true

  Ordered quantity that has been received.
• ReceivedWithQualifier: string
  Title: Received

  Read Only: true

  Maximum Length: 255

  Quantity or amount received against the purchase order schedule.
• RequestedAmount: number
  Read Only: true

  Amount requested on the requisition line associated with the purchase order schedule.
• RequestedQuantity: number
  Read Only: true

  Quantity requested on the requisition line associated with the purchase order schedule.
• RequestedWithQualifier: string
  Title: Requested

  Read Only: true

  Maximum Length: 255

  Quantity or amount requested on the requisition line associated with the purchase order schedule.
• Requisition: string
  Read Only: true

  Maximum Length: 64

  Number that identifies the requisition.
• RequisitionLine: number
  Read Only: true

  Number that uniquely identifies the requisition line for the requisition.
• RequisitionNumberLineNumber: string
  Title: Requisition - Line

  Read Only: true

  Maximum Length: 105

  Requisition and line number for a requisition.
• ScheduleDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• ScheduleNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• SecondaryUOM: string
  Read Only: true

  Maximum Length: 3

  An alternative UOM that's allowed to quantify a dual UOM-controlled item.
• SecondaryUOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item.
• ShippedQuantity: number
  Read Only: true

  Total number of items shipped by the supplier.
• ShippedQuantityWithQualifier: string
  Title: Shipped

  Read Only: true

  Maximum Length: 255

  Total number of items shipped by the supplier in the purchase order line UOM.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure that the item uses for quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ScheduleDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "ReceivedAmount":{
            "type":"number",
            "description":"Ordered amount that has been received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InTransitQuantity":{
            "type":"number",
            "description":"Ordered quantity shipped by the supplier, but yet to be received at the buying organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedInSecondaryQuantity":{
            "type":"number",
            "description":"Ordered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SecondaryUOM":{
            "maxLength":3,
            "type":"string",
            "description":"An alternative UOM that's allowed to quantify a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ItemOrScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Either the description of the item or the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedInSecondaryQuantityWithQualifier":{
            "title":"Received in Secondary",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been invoiced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InTransitQuantityWithQualifier":{
            "title":"In Transit",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity shipped by the supplier, but yet to be received at the buying organization. Value is shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InReceivingQuantity":{
            "type":"number",
            "description":"Ordered quantity received by the buying organization, currently in receiving, and not delivered, or returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedInSecondaryQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been received against the purchase order schedule in the secondary UOM of a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequestedAmount":{
            "type":"number",
            "description":"Amount requested on the requisition line associated with the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumberScheduleNumber":{
            "title":"Line - Schedule",
            "maxLength":81,
            "type":"string",
            "description":"Line and schedule number for a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequisitionLine":{
            "type":"number",
            "description":"Number that uniquely identifies the requisition line for the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceAmount":{
            "type":"number",
            "description":"Ordered amount that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceQuantity":{
            "type":"number",
            "description":"Ordered quantity that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "RequestedQuantity":{
            "type":"number",
            "description":"Quantity requested on the requisition line associated with the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedAmount":{
            "type":"number",
            "description":"Total amount ordered for this purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedAmount":{
            "type":"number",
            "description":"Ordered amount that has been invoiced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedAmountWithQualifier":{
            "title":"Ordered Amount",
            "maxLength":255,
            "type":"string",
            "description":"Total amount ordered for this purchase order schedule shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequestedWithQualifier":{
            "title":"Requested",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount requested on the requisition line associated with the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedQuantityWithQualifier":{
            "title":"Ordered Quantity",
            "maxLength":255,
            "type":"string",
            "description":"Total quantity ordered for this purchase order schedule shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippedQuantityWithQualifier":{
            "title":"Shipped",
            "maxLength":255,
            "type":"string",
            "description":"Total number of items shipped by the supplier in the purchase order line UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedWithQualifier":{
            "title":"Received",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount received against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OpenToInvoiceWithQualifier":{
            "title":"Open to Invoice",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceivedQuantity":{
            "type":"number",
            "description":"Ordered quantity that has been received.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the purchase order references.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "SecondaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the UOM that's allowed to quantify a dual UOM-controlled item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Date when the goods are requested or promised for delivery.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredWithQualifier":{
            "title":"Delivered",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount delivered against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ScheduleNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicedAmountWithQualifier":{
            "title":"Invoiced Amount",
            "maxLength":255,
            "type":"string",
            "description":"Ordered amount that has been invoiced shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShippedQuantity":{
            "type":"number",
            "description":"Total number of items shipped by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "RequisitionNumberLineNumber":{
            "title":"Requisition - Line",
            "maxLength":105,
            "type":"string",
            "description":"Requisition and line number for a requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "HasMultipleReceiptsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the purchase order schedule has multiple receipts or not. Valid values are true and false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredQuantity":{
            "type":"number",
            "description":"Ordered quantity or amount that has been delivered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the item uses for quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DeliveredAmount":{
            "type":"number",
            "description":"Amount delivered against the purchase order schedule for service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedInSecondaryQuantityWithQualifier":{
            "title":"Ordered in Secondary",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity of the purchase order schedule in the secondary UOM of a dual UOM-controlled item shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OrderedQuantity":{
            "type":"number",
            "description":"Total quantity ordered for this purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InReceivingQuantityWithQualifier":{
            "title":"In Receiving",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity received by the buying organization, currently in receiving, and not delivered, or returned. Value is shown with UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Requisition":{
            "maxLength":64,
            "type":"string",
            "description":"Number that identifies the requisition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceiptDate":{
            "title":"Receipt Date",
            "type":"string",
            "description":"Date when the goods or services were received.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InvoicedQuantityWithQualifier":{
            "title":"Invoiced Quantity",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been invoiced shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseOrderLifeCycleDetails-shipments-item-response

Type: object

Show Source

• Carrier: string
  Title: Carrier

  Read Only: true

  Maximum Length: 360

  Value that uniquely identifies the carrier on the schedule.
• ExpectedReceiptDate: string (date)
  Title: Expected Receipt Date

  Read Only: true

  Date when goods are expected to arrive.
• LineDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the item that the purchase order references.
• LineLocationId: number
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order line.
• LineNumberScheduleNumber: string
  Title: Line - Schedule

  Read Only: true

  Maximum Length: 81

  Line and schedule number for a purchase order.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• POHeaderId: number
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: number
  Read Only: true

  Value that uniquely identifies the purchase order line.
• ReceiptDate: string (date)
  Title: Receipt Date

  Read Only: true

  Date when the goods or services were received.
• ScheduleNumber: number
  Read Only: true

  Number that uniquely identifies the purchase order schedule for the purchase order line.
• Shipment: string
  Title: Shipment

  Read Only: true

  Maximum Length: 30

  Number that identifies the shipment.
• ShipmentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the shipment.
• ShippedDate: string (date)
  Title: Shipped Date

  Read Only: true

  Date on which goods were shipped.
• ShippedQuantity: number
  Read Only: true

  Total number of items shipped by the supplier.
• ShippedQuantityWithQualifier: string
  Title: Quantity

  Read Only: true

  Maximum Length: 255

  Total number of items shipped by the supplier in the purchase order line UOM.
• Tracking: string
  Title: Tracking

  Read Only: true

  Maximum Length: 20

  Alphanumeric value used for tracking a waybill.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure that the item uses for quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ShipmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the shipment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Tracking":{
            "title":"Tracking",
            "maxLength":20,
            "type":"string",
            "description":"Alphanumeric value used for tracking a waybill.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShippedDate":{
            "title":"Shipped Date",
            "type":"string",
            "description":"Date on which goods were shipped.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ShippedQuantity":{
            "type":"number",
            "description":"Total number of items shipped by the supplier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "LineNumberScheduleNumber":{
            "title":"Line - Schedule",
            "maxLength":81,
            "type":"string",
            "description":"Line and schedule number for a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Shipment":{
            "title":"Shipment",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the shipment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShippedQuantityWithQualifier":{
            "title":"Quantity",
            "maxLength":255,
            "type":"string",
            "description":"Total number of items shipped by the supplier in the purchase order line UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the item uses for quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POHeaderId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the purchase order references.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpectedReceiptDate":{
            "title":"Expected Receipt Date",
            "type":"string",
            "description":"Date when goods are expected to arrive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "POLineId":{
            "type":"number",
            "description":"Value that uniquely identifies the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "Carrier":{
            "title":"Carrier",
            "maxLength":360,
            "type":"string",
            "description":"Value that uniquely identifies the carrier on the schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ReceiptDate":{
            "title":"Receipt Date",
            "type":"string",
            "description":"Date when the goods or services were received.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top