Jump to

• Request
• Response
• Examples

Get one schedule

get

/fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules/{purchaseOrderSchedulesUniqID}

Request

Path Parameters

• purchaseOrderSchedulesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Purchase Order Schedules resource and used to uniquely identify an instance of Purchase Order Schedules. The client should not generate the hash key value. Instead, the client should query on the Purchase Order Schedules collection resource in order to navigate to a specific instance of Purchase Order Schedules to get the hash key.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : purchaseOrderSchedules-item-response

Type: object

Show Source

• AcceptedAmount: number
  Title: Accepted Amount

  Read Only: true

  Amount accepted for service lines.
• AcceptedQuantity: number
  Title: Accepted Quantity

  Read Only: true

  Quantity accepted after inspection.
• AccrueAtReceiptFlag: boolean
  Title: Accrue at Receipt

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then accrue the purchase order schedule upon receipt. If false, then do not accrue upon receipt.
• Amount: number
  Title: Ordered

  Read Only: true

  Amount for the service on the purchase order schedule.
• AnticipatedArrivalDate: string (date)
  Title: Anticipated Arrival Date

  Read Only: true

  Date when the ordered goods are expected to be delivered based on the current projected date of shipping.
• BilledAmount: number
  Title: Invoiced Amount

  Read Only: true

  Amount equivalent of the matched invoice lines based on the purchase price.
• BilledQuantity: number
  Title: Invoiced Quantity

  Read Only: true

  Quantity invoiced against the purchase order schedule.
• Buyer: string
  Title: Buyer

  Read Only: true

  Maximum Length: 240

  Person who is responsible for managing the purchase order.
• BuyerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the buyer.
• Category: string
  Title: Category Name

  Read Only: true

  Maximum Length: 2400

  Name of the purchasing category that the purchase order uses to classify the purchase for the order line.
• CategoryCode: string
  Read Only: true

  Maximum Length: 820

  Abbreviation that identifies the purchasing category.
• CategoryId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing category.
• ClosedReason: string
  Title: Closed Reason

  Read Only: true

  Maximum Length: 240

  Text that describes the reason why the schedule was closed.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the buyer or application created the purchase order schedule.
• DocumentStatus: string
  Title: Order Status

  Read Only: true

  Maximum Length: 80

  Status of the purchase order relative to the purchase order life cycle.
• DocumentStatusCode: string
  Title: Document Status Code

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the purchase order status in the order life cycle.
• DocumentStyle: string
  Title: Document Style

  Read Only: true

  Maximum Length: 240

  Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.
• DocumentStyleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchasing style of the document.
• FreightTerms: string
  Title: Freight Terms

  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of freight terms for the purchase order.
• FundsStatus: string
  Title: Funds Status

  Read Only: true

  Maximum Length: 80

  Status of the funds check or funds reservation validation result for the schedule.
• FundsStatusCode: string
  Title: Funds Status

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the funds status.
• InvoiceMatchOption: string
  Title: Invoice Match Option

  Read Only: true

  Maximum Length: 80

  Value that determines whether to match the invoice to the purchase order or the receipt. If the purchase order line is under consignment, then match each invoice to the consumption advice.
• InvoiceMatchOptionCode: string
  Title: Invoice Match Option Code

  Read Only: true

  Maximum Length: 25

  Determines whether the invoice for the purchase order schedule must match the purchase order or the receipt. Values include C for consumption advice, P for order, or R for receipt.
• ItemDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

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

  Value that uniquely identifies the item on the purchase order.
• ItemNumber: string
  Title: Item

  Read Only: true

  Abbreviation that uniquely identifies the item on the purchase order.
• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• LineNumber: number
  Title: Line

  Read Only: true

  Number that uniquely identifies the purchase order line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderNumber: string
  Title: Order

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the purchase order in the sold-to legal entity.
• PaymentTerms: string
  Title: Payment Terms

  Read Only: true

  Maximum Length: 50

  Terms that the application uses to schedule payments and calculate due dates, discount dates, and discount amounts for each invoice against the purchase order.
• PaymentTermsId: integer (int64)
  Read Only: true

  Value that uniquely identifies the payment terms.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order.
• POLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the parent line of the schedule. This attribute is used when the schedule is split.
• Price: number
  Title: Price

  Read Only: true

  Price of the purchase order line.
• ProcurementBU: string
  Title: Procurement BU

  Read Only: true

  Maximum Length: 240

  Business unit that manages and owns the purchase order.
• ProcurementBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit that manages and owns the purchase order.
• PurchaseBasis: string
  Title: Purchase Basis

  Read Only: true

  Maximum Length: 80

  Value that indicates whether the schedule is for goods or services.
• PurchaseBasisCode: string
  Title: Purchase Basis Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that indicates if the schedule is for quantity based purchases or fixed price services.
• Quantity: number
  Title: Quantity

  Read Only: true

  Quantity of the item scheduled to be shipped or delivered.
• ReceivedAmount: number
  Title: Received Amount

  Read Only: true

  Amount received for service lines.
• ReceivedQuantity: number
  Title: Received Quantity

  Read Only: true

  Quantity received against the purchase order schedule.
• RequestedDeliveryDate: string (date)
  Title: Requested Delivery Date

  Read Only: true

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

  Read Only: true

  Date when the buyer requested that the supplier ship the item.
• RequisitioningBU: string
  Title: Requisitioning BU

  Read Only: true

  Maximum Length: 240

  Business unit that creates the requisition.
• RequisitioningBUId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business unit that creates the requisition.
• RetainageAmount: number
  Title: Retainage

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Amount of retainage released for the schedule.
• ScheduleDescription: string
  Title: Schedule Description

  Read Only: true

  Maximum Length: 240

  Description of the work associated with a progress payment schedule.
• ScheduleNumber: integer
  Title: Schedule

  Read Only: true

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

  Read Only: true

  Maximum Length: 80

  Status of the purchase order schedule.
• ScheduleStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the status of the purchase order schedule.
• ScheduleType: string
  Title: Schedule Type

  Read Only: true

  Maximum Length: 80

  Value that identifies whether the payment is released based on units of work or lump sum.
• ScheduleTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the schedule type.
• ShippedAmount: number
  Title: Shipped Amount

  Read Only: true

  Amount shipped for service lines.
• ShippedQuantity: number
  Title: Shipped Quantity

  Read Only: true

  Quantity shipped against the purchase order schedule.
• ShipToCustomer: string
  Title: Ship-to Party

  Read Only: true

  Maximum Length: 360

  Name of the party who receives the item that the supplier ships.
• ShipToCustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the third party that receives the item.
• ShipToLocation: string
  Title: Ship-to Location

  Read Only: true

  Maximum Length: 240

  Name of the location where the supplier ships the item.
• ShipToLocationCode: string
  Title: Ship-to Location Code

  Read Only: true

  Maximum Length: 60

  Abbreviation that identifies the location where the supplier ships the item.
• ShipToLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the location where the supplier ships the item.
• SoldToLegalEntity: string
  Title: Sold-to Legal Entity

  Read Only: true

  Maximum Length: 240

  Legal entity that is financially responsible for purchases on the purchase order.
• SoldToLegalEntityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
• Supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  Name of the supplier who fulfills the item.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier.
• SupplierItem: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 300

  Number that the supplier uses to identify the item on the purchase order line.
• SupplierSite: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 240

  Location that the supplier uses to purchase the item.
• SupplierSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier site.
• Total: number
  Title: Total

  Read Only: true

  Total of the ordered amount and the exclusive tax amounts on the purchase order line.
• TotalTax: number
  Title: Total Tax

  Read Only: true

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

  Read Only: true

  Maximum Length: 25

  Unit of measure in the item quantity.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ReceivedAmount":{
            "title":"Received Amount",
            "type":"number",
            "description":"Amount received for service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryCode":{
            "maxLength":"820",
            "type":"string",
            "description":"Abbreviation that identifies the purchasing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleDescription":{
            "title":"Schedule Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the work associated with a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ShippedAmount":{
            "title":"Shipped Amount",
            "type":"number",
            "description":"Amount shipped for service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the buyer or application created the purchase order schedule.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that creates the requisition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ScheduleType":{
            "title":"Schedule Type",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies whether the payment is released based on units of work or lump sum.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ScheduleStatusCode":{
            "title":"Status Code",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the status of the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Sold-to Legal Entity",
            "maxLength":"240",
            "type":"string",
            "description":"Legal entity that is financially responsible for purchases on the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PurchaseBasis":{
            "title":"Purchase Basis",
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates whether the schedule is for goods or services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AcceptedAmount":{
            "title":"Accepted Amount",
            "type":"number",
            "description":"Amount accepted for service lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ClosedReason":{
            "title":"Closed Reason",
            "maxLength":"240",
            "type":"string",
            "description":"Text that describes the reason why the schedule was closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundsStatusCode":{
            "title":"Funds Status",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the funds status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequisitioningBU":{
            "title":"Requisitioning BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that creates the requisition.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RetainageReleasedAmount":{
            "title":"Retainage Released",
            "type":"number",
            "description":"Amount of retainage released for the schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnticipatedArrivalDate":{
            "title":"Anticipated Arrival Date",
            "type":"string",
            "description":"Date when the ordered goods are expected to be delivered based on the current projected date of shipping.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent line of the schedule. This attribute is used when the schedule is split.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that manages and owns the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ProcurementBU":{
            "title":"Procurement BU",
            "maxLength":"240",
            "type":"string",
            "description":"Business unit that manages and owns the purchase order.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BilledAmount":{
            "title":"Invoiced Amount",
            "type":"number",
            "description":"Amount equivalent of the matched invoice lines based on the purchase price.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PaymentTermsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment terms.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RetainageRate":{
            "title":"Retainage Rate",
            "type":"number",
            "description":"Percentage of the invoice value that can be withheld as retainage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Price of the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSite":{
            "title":"Supplier Site",
            "maxLength":"240",
            "type":"string",
            "description":"Location that the supplier uses to purchase the item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToCustomer":{
            "title":"Ship-to Party",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party who receives the item that the supplier ships.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Category":{
            "title":"Category Name",
            "maxLength":"2400",
            "type":"string",
            "description":"Name of the purchasing category that the purchase order uses to classify the purchase for the order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ScheduleTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the schedule type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Buyer":{
            "title":"Buyer",
            "maxLength":"240",
            "type":"string",
            "description":"Person who is responsible for managing the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "PaymentTerms":{
            "title":"Payment Terms",
            "maxLength":"50",
            "type":"string",
            "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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item that the purchase order references.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "LineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "InvoiceMatchOptionCode":{
            "title":"Invoice Match Option Code",
            "maxLength":"25",
            "type":"string",
            "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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DocumentStyle":{
            "title":"Document Style",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShipToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the third party that receives the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReceivedQuantity":{
            "title":"Received Quantity",
            "type":"number",
            "description":"Quantity received against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ItemNumber":{
            "title":"Item",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the item on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchaseBasisCode":{
            "title":"Purchase Basis Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates if the schedule is for quantity based purchases or fixed price services.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "InvoiceMatchOption":{
            "title":"Invoice Match Option",
            "maxLength":"80",
            "type":"string",
            "description":"Value that 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.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "TotalTax":{
            "title":"Total Tax",
            "type":"number",
            "description":"Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundsStatus":{
            "title":"Funds Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the funds check or funds reservation validation result for the schedule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location Code",
            "maxLength":"60",
            "type":"string",
            "description":"Abbreviation that identifies the location where the supplier ships the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AcceptedQuantity":{
            "title":"Accepted Quantity",
            "type":"number",
            "description":"Quantity accepted after inspection.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentStatusCode":{
            "title":"Document Status Code",
            "maxLength":"25",
            "type":"string",
            "description":"Abbreviation that identifies the purchase order status in the order life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the supplier who fulfills the item.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "BilledQuantity":{
            "title":"Invoiced Quantity",
            "type":"number",
            "description":"Quantity invoiced against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ScheduleNumber":{
            "title":"Schedule",
            "type":"integer",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the location where the supplier ships the item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SoldToLegalEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShippedQuantity":{
            "title":"Shipped Quantity",
            "type":"number",
            "description":"Quantity shipped against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "Amount":{
            "title":"Ordered",
            "type":"number",
            "description":"Amount for the service on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "AccrueAtReceiptFlag":{
            "title":"Accrue at Receipt",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then accrue the purchase order schedule upon receipt. If false, then do not accrue upon receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of the item scheduled to be shipped or delivered.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentStatus":{
            "title":"Order Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the purchase order relative to the purchase order life cycle.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure in the item quantity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit",
                "includeInCompactView":true
            }
        },
        "FreightTermsCode":{
            "title":"Freight Terms Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of freight terms for the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Total":{
            "title":"Total",
            "type":"number",
            "description":"Total of the ordered amount and the exclusive tax amounts on the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestedDeliveryDate":{
            "title":"Requested Delivery Date",
            "type":"string",
            "description":"Date when the buyer requested that the supplier deliver the item.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "RequestedShipDate":{
            "title":"Requested Ship Date",
            "type":"string",
            "description":"Date when the buyer requested that the supplier ship the item.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "DocumentStyleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchasing style of the document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FreightTerms":{
            "title":"Freight Terms",
            "maxLength":"80",
            "type":"string",
            "description":"Terms that describe who pays the charges to transport the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "RetainageAmount":{
            "title":"Retainage",
            "type":"number",
            "description":"Total amount withheld as retainage against the schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ScheduleStatus":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the purchase order schedule.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "SupplierItem":{
            "title":"Supplier Item",
            "maxLength":"300",
            "type":"string",
            "description":"Number that the supplier uses to identify the item on the purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        }
    }
}

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."
        }
    }
}

Links

close

Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules/{purchaseOrderSchedulesUniqID}/action/close

Parameters:

• purchaseOrderSchedulesUniqID: $request.path.purchaseOrderSchedulesUniqID

Closes a purchase order schedule. You can manually close for receiving, close for invoicing, close, or finally close a schedule.

confirmWork

Operation: /fscmRestApi/resources/11.13.18.05/purchaseOrderSchedules/{purchaseOrderSchedulesUniqID}/action/confirmWork

Parameters:

• purchaseOrderSchedulesUniqID: $request.path.purchaseOrderSchedulesUniqID

Add lines to an existing work confirmation on the progress payment schedule. You can provide the quantity, amount, or percentage of work completed on the schedule for a performance period.

Back to Top

Examples

This example describes how to get one schedule.

Example cURL Command

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

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

For example, the following command gets purchase order schedule where the line location identifier is 300100185985737:

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

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
	"POHeaderId": 300100185985423,
	"OrderNumber": "1011589",
	"ItemDescription": "test fps",
	"Price": null,
	"LineNumber": 2,
	"SupplierItem": null,
	"LineLocationId": 300100185985737,
	"ScheduleNumber": 1,
	"RequestedDeliveryDate": null,
	"ScheduleStatusCode": "CANCELED",
	"ClosedReason": null,
	"InvoiceMatchOptionCode": "P",
	"BilledQuantity": null,
	"ShippedQuantity": null,
	"ReceivedQuantity": null,
	"AcceptedQuantity": null,
	"BilledAmount": 0,
	"ShippedAmount": 0,
	"ReceivedAmount": 0,
	"AcceptedAmount": 0,
	"SoldToLegalEntity": "Vision Operations",
	"UOM": null,
	"ScheduleStatus": "Canceled",
	"Category": "Miscellaneous_1",
	"Buyer": "Furey,Clare",
	"InvoiceMatchOption": "Order",
	"PaymentTerms": "45 Net (terms date + 45)",
	"FreightTerms": "Due",
	"ShipToCustomer": null,
	"PurchaseBasisCode": "SERVICES",
	"ItemNumber": null,
	"Total": 0,
	"TotalTax": 0,
	"PurchaseBasis": "Services",
	"Quantity": null,
	"Amount": 0,
	"ShipToLocation": "V1- New York City",
	"DocumentStatus": "Canceled",
	"AnticipatedArrivalDate": null,
	"CreationDate": "2020-04-15T17:12:01+00:00",
	"RequestedShipDate": null,
	"Supplier": "CV_SuppA01",
	"SupplierSite": "CVSuppA01Site01",
	"RetainageRate": null,
        "RetainageAmount": null,
        "RetainageReleasedAmount": null,
        "ProcurementBU": "Vision Operations",
        "RequisitioningBU": "Vision Operations",
        "DocumentStyle": "Purchase Order",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737",
		"name": "purchaseOrderSchedules",
		"kind": "item"
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737",
		"name": "purchaseOrderSchedules",
		"kind": "item"
	},
	{
		"rel": "action",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/300100185985737/action/close",
		"name": "close",
		"kind": "other"
	}
	]
}

Example 2

This example shows how to query additional attributes using the the fields parameter.

Example 2 cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453?fields=OrderNumber,ShipToLocationId,ShipToLocationCode,ShipToLocation,ItemId,CategoryId,SoldToLegalEntityId"

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
    "OrderNumber": "1000033",
    "ShipToLocationId": 211,
    "ShipToLocationCode": "VC - Vision City",
    "ShipToLocation": "VC - Vision City",
    "ItemId": null,
    "CategoryId": 2920,
    "SoldToLegalEntityId": 458,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453",
            "name": "purchaseOrderSchedules",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453",
            "name": "purchaseOrderSchedules",
            "kind": "item"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453/action/close",
            "name": "close",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/purchaseOrderSchedules/100000017965453/action/confirmWork",
            "name": "confirmWork",
            "kind": "other"
        }
    ]
}

Back to Top