Get all schedules

get

/fscmRestApi/resources/11.13.18.05/purchaseOrders/{purchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
  • This is the hash key of the attributes which make up the composite key for the Purchase Orders resource and used to uniquely identify an instance of Purchase Orders. The client should not generate the hash key value. Instead, the client should query on the Purchase Orders collection resource in order to navigate to a specific instance of Purchase Orders to get the hash key.
Query Parameters
  • 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>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

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

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

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds a purchase order schedule according to the line location identifier.
      Finder Variables
      • LineLocationId; integer; Value that uniquely identifies a purchase order schedule.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

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

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BackToBackFlag; boolean; Contains one of the following values: true or false. If true, then the sales order exists for the purchase order schedule, and use back-to back-fulfillment. The purchase order schedule fulfills the sales order upon receipt. If false, then the sales order doesn't exist for the purchase order schedule.
    • CountryOfOrigin; string; Country where the organization that ships and exports the item resides.
    • CountryOfOriginCode; string; Abbreviation that identifies the country where the organization resides that ships and exports the item.
    • CreatedBy; string; User who created the purchase order schedule.
    • CreationDate; string; Date and time when the buyer or application created the purchase order schedule.
    • DeliverToLocation; string; Abbreviation that identifies the final location that receives the item.
    • Description; string; Description of the work associated with the progress payment schedule.
    • DestinationType; string; Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order.
    • DestinationTypeCode; string; How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING.
    • LastUpdateDate; string; Date and time when the buyer or application most recently updated the purchase order schedule.
    • LastUpdatedBy; string; User who most recently updated the purchase order schedule.
    • LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
    • ModeOfTransportCode; string; Abbreviation that identifies the mode of transport.
    • NonRecoverableInclusiveTax; integer; Nonrecoverable tax amount included in the purchase order schedule amount. The purchaser can't recover this tax.
    • NonRecoverableTax; number; Nonrecoverable tax amount not included in the purchase order schedule amount. The purchaser can't recover this tax.
    • OrchestrationAgreementLineNumber; integer; Number that identifies the orchestration agreement line.
    • OrchestrationAgreementNumber; string; Number that identifies the orchestration agreement between the legal entities, business units, and trade organizations establishing a trade relationship.
    • POTradingOrganization; string; Name of the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
    • POTradingOrganizationCode; string; Abbreviation that identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
    • POTradingOrganizationId; integer; Value that uniquely identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
    • Price; number; Price of the purchase order line.
    • PricingUOM; string; Abbreviation that identifies the unit of measure the item uses for pricing.
    • PricingUOMCode; string; Unit of measure that the item uses for pricing.
    • PrimaryTradeRelationshipId; integer; Value that uniquely identifies the primary trade relationship in an orchestration agreement.
    • PromisedDeliveryDate; string; Date when the supplier promises to deliver the item to the buyer.
    • PromisedShipDate; string; Date when the supplier promises to ship the item to the buyer.
    • RecoverableInclusiveTax; integer; Recoverable tax amount included in the purchase order schedule amount. The purchaser can recover this tax.
    • RecoverableTax; number; Recoverable tax amount not included in the purchase order schedule amount. The purchaser can recover this tax.
    • RequestedDeliveryDate; string; Date when the buyer requests that the supplier deliver the item.
    • RequestedShipDate; string; Date when the buyer requests that the supplier ship the item.
    • Requester; string; Display name of the deliver-to person or requester.
    • Requisition; string; Number that identifies the requisition.
    • RequisitionHeaderId; integer; Value that uniquely identifies the requisition header.
    • RetainageAmount; number; Total amount withheld as retainage against the schedule.
    • RetainageRate; number; Percentage of the invoice value that can be withheld as retainage.
    • RetainageReleasedAmount; number; Amount of retainage released for the schedule.
    • SalesOrderNumber; string; Number that uniquely identifies the sales order that the purchase order schedule references.
    • ScheduleNumber; number; Number that uniquely identifies the purchase order schedule for the purchase order line.
    • ShipToCustomer; string; Name of the party who receives the item that the supplier ships.
    • ShipToCustomerId; integer; Value that uniquely identifies the third party that receives the item.
    • ShipToCustomerLocation; string; Value that identifies the external address where the supplier ships the item.
    • ShipToCustomerLocationId; integer; Value that uniquely identifies the external location where the supplier ships the item.
    • ShipToLocationCode; string; Abbreviation that identifies the location where the supplier ships the item.
    • ShipToLocationId; integer; Value that uniquely identifies the location where the supplier ships the item.
    • ShipToOrganization; string; Name of the inventory organization that receives the item.
    • ShipToOrganizationCode; string; Abbreviation that identifies the inventory organization where the supplier ships the item.
    • ShipToOrganizationId; integer; Value that uniquely identifies the inventory organization where the supplier ships the item.
    • ShippingMethod; string; Shipping method on the purchase order schedule.
    • Status; string; Status of the purchase order schedule.
    • StatusCode; string; Abbreviation that identifies the status of the purchase order schedule.
    • Subinventory; string; Subinventory that identifies where to deliver the requested item.
    • Type; string; Type of payment released based on units of work or a lump sum amount.
    • TypeCode; string; Abbreviation that identifies the schedule type.
    • UOMCode; string; Abbreviation that identifies the unit of measure.
    • WorkOrderId; integer; Value that uniquely identifies the work order in the factory.
    • WorkOrderNumber; string; Display number that uniquely identifies the work order in the factory.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : purchaseOrders-lines-schedules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : purchaseOrders-lines-schedules-item-response
Type: object
Show Source
  • Title: Accrue at Receipt
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then accrue the purchase order schedule at receipt. If false, then don't accrue it at receipt.
  • Title: Allow Substitute Receipts
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the purchase order schedule allows the application to use a substitute item in place of the ordered item. If false, then the purchase order schedule doesn't allow a substitute item.
  • Title: Assessable Value
    Read Only: true
    Value of the product that can be assessable.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Back-to-Back Order
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the sales order exists for the purchase order schedule, and use back-to back-fulfillment. The purchase order schedule fulfills the sales order upon receipt. If false, then the sales order doesn't exist for the purchase order schedule.
  • Title: Invoice Matched
    Read Only: true
    Amount equivalent of the matched invoice lines based on the purchase price.
  • Title: Invoiced Quantity
    Read Only: true
    Quantity invoiced against the purchase order schedule.
  • Title: Carrier
    Read Only: true
    Maximum Length: 360
    Company that transports the item.
  • Read Only: true
    Value that uniquely identifies the company that transports the item.
  • Title: Country of Origin
    Read Only: true
    Maximum Length: 80
    Country where the organization that ships and exports the item resides.
  • Title: Country of Origin
    Read Only: true
    Maximum Length: 2
    Abbreviation that identifies the country where the organization resides that ships and exports the item.
  • Read Only: true
    Maximum Length: 64
    User who created the purchase order schedule.
  • Title: Creation Date
    Read Only: true
    Date and time when the buyer or application created the purchase order schedule.
  • Title: Currency
    Read Only: true
    Maximum Length: 80
    Purchase order currency.
  • Read Only: true
    Maximum Length: 15
    Abbreviation that identifies the purchase order currency.
  • Title: Customer Item
    Read Only: true
    Maximum Length: 25
    Value that identifies the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Item Description
    Read Only: true
    Maximum Length: 240
    Description of the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order Line
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order line for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Customer Purchase Order Schedule
    Read Only: true
    Maximum Length: 50
    Number that identifies the purchase order schedule for the product being procured for a customer, which is used in the customer's sales order in a drop ship arrangement.
  • Title: Deliver-to Location
    Read Only: true
    Abbreviation that identifies the final location that receives the item.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the work associated with the progress payment schedule.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 80
    Determines how to charge the item. Values include Inventory, Expense, Drop Ship, or Work Order.
  • Title: Destination Type
    Read Only: true
    Maximum Length: 25
    How to use the item during fulfillment. Values include INVENTORY, EXPENSE, DROP SHIP, or MANUFACTURING.
  • DFF
  • Distributions
    Title: Distributions
    Purchasing details, such as details about accounting or the project.
  • Title: Early Receipt Tolerance in Days
    Read Only: true
    Maximum number of days the application allows to receive an early shipment.
  • Title: Firm
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the schedule can't be changed by the manufacturing application. If false, then the schedule can be changed by the manufacturing application. This attribute doesn't have a default value.
  • globalDFFs
  • Title: Invoice Close Tolerance Percent
    Read Only: true
    Percent that the application uses to determine whether to close a purchase order schedule when the invoice invoices only part of the item.
  • Title: Invoice Match Option
    Read Only: true
    Maximum Length: 80
    Determines whether to match the invoice to the purchase order or the receipt. If the purchase order line is under consignment, then match each invoice to the consumption advice.
  • Title: Invoice Match Option
    Read Only: true
    Maximum Length: 25
    Determines whether the invoice for the purchase order schedule must match the purchase order or the receipt. Values include C for consumption advice, P for order, or R for receipt.
  • Title: Kanban Card
    Read Only: true
    Maximum Length: 200
    Value that uniquely identifies the Kanban card.
  • Title: Last Acceptable Delivery Date
    Read Only: true
    Last date when the shipper can deliver the item.
  • Title: Last Acceptable Ship Date
    Read Only: true
    Last date when the shipper can ship the item.
  • Read Only: true
    Last date when the receiver can receive the item.
  • Read Only: true
    Date and time when the buyer or application most recently updated the purchase order schedule.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the purchase order schedule.
  • Title: Late Receipt Tolerance in Days
    Read Only: true
    Maximum number of days the application allows to receive a late shipment.
  • Title: Intended Use
    Read Only: true
    Maximum Length: 240
    Purpose for which a product is likely to be used in the business by the purchaser.
  • Title: Intended Use
    Read Only: true
    Value that uniquely identifies the intended use of a product in the business by the purchaser.
  • Read Only: true
    Value that uniquely identifies the purchase order schedule.
  • Title: Line
    Read Only: true
    Number that uniquely identifies the purchase order line.
  • Links
  • Title: Location of Final Discharge
    Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the final discharge location.
  • Read Only: true
    Value that uniquely identifies the final discharge location.
  • Title: Match Approval Level
    Read Only: true
    Specifies how quantities on the purchase order, receipt, inspection, and invoice must match before the buyer can pay the invoice. Values include 2-Way, 3-Way, or 4-Way.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 80
    Mode of transportation that ships the item, such as truck, air, or boat.
  • Title: Mode of Transport
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the mode of transport.
  • Title: Nonrecoverable Inclusive Tax
    Read Only: true
    Nonrecoverable tax amount included in the purchase order schedule amount. The purchaser can't recover this tax.
  • Title: Nonrecoverable Tax
    Read Only: true
    Nonrecoverable tax amount not included in the purchase order schedule amount. The purchaser can't recover this tax.
  • Title: Note to Receiver
    Read Only: true
    Maximum Length: 1000
    Note that the receiver can read to get details about how to process the purchase order schedule.
  • Read Only: true
    Number that identifies the orchestration agreement line.
  • Title: Financial Orchestration Flow
    Read Only: true
    Maximum Length: 100
    Number that identifies the orchestration agreement between the legal entities, business units, and trade organizations establishing a trade relationship.
  • Title: Ordered
    Read Only: true
    Price multiplied by the scheduled quantity. If the purchase order line references a fixed price service, then this attribute contains the same value that the scheduled amount contains.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number that uniquely identifies the purchase order in the sold-to legal entity.
  • Title: Original Promised Delivery Date
    Read Only: true
    Date when the supplier promises to deliver the item that the buyer ordered.
  • Title: Original Promised Ship Date
    Read Only: true
    Date when the supplier promises to ship the item that the buyer ordered.
  • Title: Overreceipt Action
    Read Only: true
    Maximum Length: 80
    Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include None, Reject, or Warning.
  • Title: Overreceipt Action
    Read Only: true
    Maximum Length: 25
    Action to take when the receipt exceeds the value that the OverReceiptTolerancePercent attribute specifies. Values include NONE, REJECT, or WARNING.
  • Title: Overreceipt Tolerance Percent
    Read Only: true
    Percent tolerance to use when receiving more than the ordered quantity or amount without starting the action that the OverReceiptActionCode attribute specifies.
  • Read Only: true
    Value that uniquely identifies the purchase order.
  • Read Only: true
    Value that uniquely identifies the parent of the purchase order line.
  • Read Only: true
    Name of the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Read Only: true
    Abbreviation that identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Read Only: true
    Value that uniquely identifies the inventory organization reporting to the sold-to legal entity identified on a purchase order. This organization is used for cost accounting the transactions in the sold-to legal entity.
  • Title: Price
    Read Only: true
    Price of the purchase order line.
  • Title: Pricing UOM
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the unit of measure the item uses for pricing.
  • Read Only: true
    Maximum Length: 3
    Unit of measure that the item uses for pricing.
  • Read Only: true
    Value that uniquely identifies the primary trade relationship in an orchestration agreement.
  • Title: Product Category
    Read Only: true
    Maximum Length: 1996
    Name of the category used to classify products for tax purposes.
  • Title: Product Category
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the category used to classify products for tax purposes.
  • Title: Product Fiscal Classification
    Read Only: true
    Maximum Length: 240
    Tax classification used by a tax authority to categorize a product.
  • Read Only: true
    Maximum Length: 255
    Abbreviation that identifies the fiscal classification of a product by tax authority for tax purposes.
  • Read Only: true
    Value that uniquely identifies the fiscal classification of a product by tax authority for tax purposes. It's based on the inventory item category.
  • Title: Product Type
    Read Only: true
    Maximum Length: 80
    Value that determines how the tax is calculated. Values include goods and services.
  • Title: Product Type
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the product type.
  • Title: Promised Delivery Date
    Read Only: true
    Date when the supplier promises to deliver the item to the buyer.
  • Title: Promised Ship Date
    Read Only: true
    Date when the supplier promises to ship the item to the buyer.
  • Title: Quantity
    Read Only: true
    Scheduled quantity of the item.
  • Title: Receipt Close Tolerance Percent
    Read Only: true
    Percent that the application uses to determine whether to close a purchase order schedule when the receiver receives only part of the item.
  • Title: Receipt Date Exception Action
    Read Only: true
    Maximum Length: 80
    Action to take when the buyer doesn't receive the purchase ordered quantity or doesn't receive the amount before the value that the Late Receipt Tolerance Days attribute specifies. Values include None, Reject, or Warning.
  • Title: Receipt Date Exception Action
    Read Only: true
    Maximum Length: 25
    Action to take when the application doesn't receive the purchase ordered quantity or amount before the value that the Late Receipt Tolerance Days attribute specifies. Values include NONE, REJECT, or WARNING.
  • Title: Receipt Routing
    Read Only: true
    Maximum Length: 80
    Routing to use when receiving the item. Values include Standard Receipt, Inspection Required, or Direct Delivery.
  • Title: Receipt Routing
    Read Only: true
    How to simplify transaction entry when routing the receipt. Values include 1 for standard receipt, 2 for inspection required, or 3 for direct delivery.
  • Title: Received
    Read Only: true
    Amount received for service lines.
  • Title: Received Quantity
    Read Only: true
    Quantity received against the purchase order schedule.
  • Title: Recoverable Inclusive Tax
    Read Only: true
    Recoverable tax amount included in the purchase order schedule amount. The purchaser can recover this tax.
  • Title: Recoverable Tax
    Read Only: true
    Recoverable tax amount not included in the purchase order schedule amount. The purchaser can recover this tax.
  • Title: Requested Delivery Date
    Read Only: true
    Date when the buyer requests that the supplier deliver the item.
  • Title: Requested Ship Date
    Read Only: true
    Date when the buyer requests that the supplier ship the item.
  • Title: Requester
    Read Only: true
    Display name of the deliver-to person or requester.
  • Title: Requisition
    Read Only: true
    Number that identifies the requisition.
  • Title: Nonrecoverable Inclusive Tax
    Read Only: true
    Value that uniquely identifies the requisition header.
  • Title: Retainage
    Read Only: true
    Total amount withheld as retainage against the schedule.
  • Title: Retainage Rate
    Read Only: true
    Percentage of the invoice value that can be withheld as retainage.
  • Title: Retainage Released
    Read Only: true
    Amount of retainage released for the schedule.
  • Title: Customer Sales Order Line
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order line that the purchase order schedule references.
  • Title: Customer Sales Order
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order that the purchase order schedule references.
  • Title: Customer Sales Order Schedule
    Read Only: true
    Maximum Length: 50
    Number that uniquely identifies the sales order schedule that the purchase order schedule references.
  • Title: Schedule
    Read Only: true
    Number that uniquely identifies the purchase order schedule for the purchase order line.
  • Title: Secondary Quantity
    Read Only: true
    Scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Title: Secondary UOM
    Read Only: true
    Maximum Length: 25
    Secondary unit of measure to use for the quantity when more than one unit of measure controls the item.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the scheduled quantity in the secondary unit of measure. Applies when more than one unit of measure controls the item.
  • Title: Shipping Method
    Read Only: true
    Maximum Length: 255
    Shipping method on the purchase order schedule.
  • Title: Ship-to Party
    Read Only: true
    Maximum Length: 360
    Name of the party who receives the item that the supplier ships.
  • Title: Ship-to Customer Contact
    Read Only: true
    Maximum Length: 360
    Name of the contact from the company where the goods are shipped.
  • Read Only: true
    Value that uniquely identifies the contact from the company where the goods are shipped.
  • Read Only: true
    Value that uniquely identifies the third party that receives the item.
  • Title: Ship-to Customer Location
    Read Only: true
    Maximum Length: 255
    Value that identifies the external address where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the external location where the supplier ships the item.
  • Title: Ship-to Exception Action
    Read Only: true
    Maximum Length: 80
    Action to take if an exception occurs when the receiving location is different from the ship-to location. Values include None, Reject, and Warning.
  • Title: Ship-to Exception Action
    Read Only: true
    Maximum Length: 25
    How to handle each receipt when the receiving location is different from the ship-to location. Values include NONE, REJECT, or WARNING.
  • Title: Location
    Read Only: true
    Maximum Length: 60
    Abbreviation that identifies the location where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the location where the supplier ships the item.
  • Title: Ship-to Organization
    Read Only: true
    Maximum Length: 240
    Name of the inventory organization that receives the item.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the inventory organization where the supplier ships the item.
  • Read Only: true
    Value that uniquely identifies the inventory organization where the supplier ships the item.
  • Title: Status
    Read Only: true
    Maximum Length: 80
    Status of the purchase order schedule.
  • Title: Status
    Read Only: true
    Maximum Length: 25
    Abbreviation that identifies the status of the purchase order schedule.
  • Title: Destination Subinventory
    Read Only: true
    Subinventory that identifies where to deliver the requested item.
  • Title: Supplier Order
    Read Only: true
    Maximum Length: 25
    Number that identifies the document that the supplier created for the purchase order.
  • Title: Supplier Order Line
    Read Only: true
    Maximum Length: 25
    Number or text that the supplier uses to identify a purchase order schedule.
  • Title: Tax Classification
    Read Only: true
    Maximum Length: 255
    Grouping of taxes for reporting and processing purposes.
  • Title: Tax Classification Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the tax classification.
  • Title: Total
    Read Only: true
    Ordered amount plus the exclusive tax amounts of the purchase order schedule.
  • Title: Total Tax
    Read Only: true
    Total of the exclusive tax amounts that the purchaser can recover and not recover for the purchase order.
  • Title: Transaction Business Category
    Read Only: true
    Maximum Length: 1996
    Classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Title: Transaction Business Category
    Read Only: true
    Maximum Length: 240
    Abbreviation that identifies the classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Read Only: true
    Value that uniquely identifies the classification or categorization of a transaction. This attribute is used for tax purposes as required by a tax authority.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    Type of payment released based on units of work or a lump sum amount.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the schedule type.
  • Title: UOM
    Read Only: true
    Maximum Length: 25
    Unit of measure in the item quantity.
  • Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure.
  • Title: User-Defined Fiscal Classification
    Read Only: true
    Maximum Length: 240
    Additional classification of the transaction for tax purposes.
  • Title: User-Defined Fiscal Classification
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the user-defined fiscal classification.
  • Read Only: true
    Value that uniquely identifies the work order in the factory.
  • Title: Work Order
    Read Only: true
    Maximum Length: 120
    Display number that uniquely identifies the work order in the factory.
  • Title: Operation Sequence
    Read Only: true
    Sequence to use when performing each work order operation.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Distributions
Type: array
Title: Distributions
Purchasing details, such as details about accounting or the project.
Show Source
Nested Schema : globalDFFs
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSPOLineLocations":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poScheduleGdf_view_PoScheduleGDFFVxUSPOLineLocationsVO-item-response" } }
Nested Schema : purchaseOrders-lines-schedules-attachments-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-schedules-DFF-item-response
Type: object
Show Source
Nested Schema : purchaseOrders-lines-schedules-distributions-item-response
Type: object
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : globalDFFs
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_publicEntity_poDistributionGdf_view_PoDistributionGDFFVxUSPODistributionsVO-item-response" } }
Nested Schema : projectDFF
Type: array
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "AP_Distribution_Sets":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response", "AP_Invoice_Distribution":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response", "AP_Invoice_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FLineVO-item-response", "EXM_Expense_Report":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReportVO-item-response", "EXM_Expense_Report_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response", "INV_Misc_Transactions":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response", "OM_Sales_Order":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFOM__5FSales__5FOrderVO-item-response", "PJC_All":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FAllVO-item-response", "PJC_Expenditure_Batch":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response", "POR_Requisition":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FRequisitionVO-item-response", "POR_User_Preferences":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response", "PO_Purchase_Order":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response", "PO_Purchase_Order_Line":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response", "PO_Purchase_Order_Schedule":"#/components/schemas/oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response" } }
Nested Schema : purchaseOrders-lines-schedules-distributions-DFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

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

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FDistribution__5FSetsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FDistributionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFAP__5FInvoice__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReportVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFEXM__5FExpense__5FReport__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFINV__5FMisc__5FTransactionsVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFOM__5FSales__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FAllVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPJC__5FExpenditure__5FBatchVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FRequisitionVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPOR__5FUser__5FPreferencesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrderVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FLineVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_prc_po_publicEntity_flex_PJCPoTransDistribution_view_PJCDFFPO__5FPurchase__5FOrder__5FScheduleVO-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_po_publicEntity_poScheduleGdf_view_PoScheduleGDFFVxUSPOLineLocationsVO-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all descriptive flexfields.

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/purchaseOrders/POHeaderId/child/lines/purchaseOrdersUniqID/child/schedules/schedulesUniqID/child/distributions/distributionsUniqID/child/DFF"

Example Response Body

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

{
	"items": [
	{
		"PoDistributionId": 300100186215739,
		"_Purchase__Order__Distributions__D": "13",
		"_Purchase__Order__Distributions__B": "14",
		"_DIST_DFF_Req_Date": "2020-07-28",
		"__FLEX_Context": null,
		"__FLEX_Context_DisplayValue": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrders/300100186215674/child/lines/300100186215733/child/schedules/300100186215734/child/distributions/300100186215739/child/DFF/300100186215739",
			"name": "DFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrders/300100186215674/child/lines/300100186215733/child/schedules/300100186215734/child/distributions/300100186215739/child/DFF/300100186215739",
			"name": "DFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/purchaseOrders/300100186215674/child/lines/300100186215733/child/schedules/300100186215734/child/distributions/300100186215739",
			"name": "distributions",
			"kind": "item"
		}
		]
	}
	],
	"count": 1,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/purchaseOrders/300100186215674/child/lines/300100186215733/child/schedules/300100186215734/child/distributions/300100186215739/child/DFF",
		"name": "DFF",
		"kind": "collection"
	}
	]
}
Back to Top