Jump to

• Request
• Response

Get work confirmation details for all schedules of a purchase order

get

/fscmRestApi/resources/11.13.18.05/purchaseOrderLifeCycleDetails/{POHeaderId}/child/workConfirmations

Request

Path Parameters

• POHeaderId(required): integer(int64)
  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=

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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

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

  • BalanceToFinish; number; Remaining amount required to complete the purchase order.
  • BalanceToFinishWithQualifier; string; Remaining amount required to complete on the purchase order schedule shown with the currency code.
  • BalanceUnitstoFinishWithQualifier; string; Units of work remaining for a progress payment schedule, shown with the unit of measure.
  • Comments; string; Comments entered for the work confirmation.
  • CompletedThisPeriodWithQualifier; string; Total amount of work completed during this period on a progress payment schedule, shown with the currency code.
  • CompletedToPeriod; number; Total amount of work completed on a progress payment schedule, as shown with the currency code.
  • CompletedToPeriodWithQualifier; string; Total amount of work completed on a progress payment schedule, as shown with the currency code.
  • CurrencyCode; string; Code that identifies the purchase order currency.
  • EndDate; string; Date when the period of performance for which the work confirmation is no longer active.
  • InvoicedWithQualifier; string; Quantity or amount invoiced against the purchase order schedule.
  • LineLocationId; integer; Value that uniquely identifies the purchase order schedule.
  • Linenumberschedulenumber; string; Line and schedule number for a purchase order.
  • OpenToInvoiceWithQualifier; string; Quantity or amount that hasn't been invoiced yet.
  • OrderedQuantityWithQualifier; string; Total quantity ordered for this purchase order schedule shown with the UOM code.
  • OrderedWithQualifier; string; Total amount ordered for this purchase order schedule shown with the currency code.
  • POHeaderId; integer; Value that uniquely identifies the purchase order.
  • PreviouslyApprovedWithQualifier; string; Total approved work confirmation amount for a progress payment schedule, shown with the currency code, prior to the current period of performance.
  • ReceiptId; number; Value that uniquely identifies the receipt.
  • ReceiptNumber; string; Number that identifies the receipt.
  • ReceivedOn; string; Date when the work confirmation is requested.
  • ReceivedWithQualifier; string; Ordered quantity that has been received shown with the UOM code.
  • Scheduledescription; string; Description of the work associated with the progress payment schedule.
  • StartDate; string; Date when the period of performance for which the work confirmation becomes active.
  • TotalUnitsCompletedtoDateWithQualifier; string; Total units of work completed for a progress payment schedule, shown with the unit of measure.
  • UOM; string; Unit of measure that the item uses for quantity.
  • UnitsCompletedThisPeriodWithQualifier; string; Units of work completed on a progress payment schedule for a period of performance, shown with the unit of measure.
  • WorkConfirmationId; integer; Value that uniquely identifies the work confirmation.
  • WorkConfirmationNumber; string; Number that uniquely identifies the work confirmation within a sold-to legal entity.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : purchaseOrderLifeCycleDetails-workConfirmations

Type: object

Show Source

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

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

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/purchaseOrderLifeCycleDetails-workConfirmations-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : purchaseOrderLifeCycleDetails-workConfirmations-item-response

Type: object

Show Source

• BalanceToFinish: number
  Read Only: true

  Remaining amount required to complete the purchase order.
• BalanceToFinishWithQualifier: string
  Title: Balance to Finish

  Read Only: true

  Maximum Length: 255

  Remaining amount required to complete on the purchase order schedule shown with the currency code.
• BalanceUnitstoFinishWithQualifier: string
  Title: Balance Units to Finish

  Read Only: true

  Maximum Length: 255

  Units of work remaining for a progress payment schedule, shown with the unit of measure.
• Comments: string
  Read Only: true

  Maximum Length: 4000

  Comments entered for the work confirmation.
• CompletedThisPeriodWithQualifier: string
  Title: Completed This Period

  Read Only: true

  Maximum Length: 255

  Total amount of work completed during this period on a progress payment schedule, shown with the currency code.
• CompletedToPeriod: number
  Read Only: true

  Total amount of work completed on a progress payment schedule, as shown with the currency code.
• CompletedToPeriodWithQualifier: string
  Title: Completed to Date

  Read Only: true

  Maximum Length: 255

  Total amount of work completed on a progress payment schedule, as shown with the currency code.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Code that identifies the purchase order currency.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  Date when the period of performance for which the work confirmation is no longer active.
• InvoicedWithQualifier: string
  Title: Invoiced

  Read Only: true

  Maximum Length: 255

  Quantity or amount invoiced against the purchase order schedule.
• LineLocationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order schedule.
• Linenumberschedulenumber: string
  Title: Line - Schedule

  Read Only: true

  Maximum Length: 81

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

  The link relations associated with the resource instance.
• OpenToInvoiceWithQualifier: string
  Title: Open to Invoice

  Read Only: true

  Maximum Length: 255

  Quantity or amount that hasn't been invoiced yet.
• OrderedQuantityWithQualifier: string
  Title: Ordered Quantity

  Read Only: true

  Maximum Length: 255

  Total quantity ordered for this purchase order schedule shown with the UOM code.
• OrderedWithQualifier: string
  Title: Ordered

  Read Only: true

  Maximum Length: 255

  Total amount ordered for this purchase order schedule shown with the currency code.
• POHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the purchase order.
• PreviouslyApprovedWithQualifier: string
  Title: Previously Approved

  Read Only: true

  Maximum Length: 255

  Total approved work confirmation amount for a progress payment schedule, shown with the currency code, prior to the current period of performance.
• ReceiptId: number
  Read Only: true

  Value that uniquely identifies the receipt.
• ReceiptNumber: string
  Title: Receipt

  Read Only: true

  Maximum Length: 30

  Number that identifies the receipt.
• ReceivedOn: string (date)
  Title: Received On

  Read Only: true

  Date when the work confirmation is requested.
• ReceivedWithQualifier: string
  Title: Received

  Read Only: true

  Maximum Length: 255

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

  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Date when the period of performance for which the work confirmation becomes active.
• TotalUnitsCompletedtoDateWithQualifier: string
  Title: Total Units Completed to Date

  Read Only: true

  Maximum Length: 255

  Total units of work completed for a progress payment schedule, shown with the unit of measure.
• UnitsCompletedThisPeriodWithQualifier: string
  Title: Units Completed This Period

  Read Only: true

  Maximum Length: 255

  Units of work completed on a progress payment schedule for a period of performance, shown with the unit of measure.
• UOM: string
  Read Only: true

  Maximum Length: 25

  Unit of measure that the item uses for quantity.
• WorkConfirmationId: integer
  Read Only: true

  Value that uniquely identifies the work confirmation.
• WorkConfirmationNumber: string
  Title: Work Confirmation

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the work confirmation within a sold-to legal entity.

{
    "type":"object",
    "properties":{
        "BalanceToFinish":{
            "type":"number",
            "description":"Remaining amount required to complete the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceToFinishWithQualifier":{
            "title":"Balance to Finish",
            "maxLength":255,
            "type":"string",
            "description":"Remaining amount required to complete on the purchase order schedule shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BalanceUnitstoFinishWithQualifier":{
            "title":"Balance Units to Finish",
            "maxLength":255,
            "type":"string",
            "description":"Units of work remaining for a progress payment schedule, shown with the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Comments":{
            "maxLength":4000,
            "type":"string",
            "description":"Comments entered for the work confirmation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedThisPeriodWithQualifier":{
            "title":"Completed This Period",
            "maxLength":255,
            "type":"string",
            "description":"Total amount of work completed during this period on a progress payment schedule, shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedToPeriod":{
            "type":"number",
            "description":"Total amount of work completed on a progress payment schedule, as shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedToPeriodWithQualifier":{
            "title":"Completed to Date",
            "maxLength":255,
            "type":"string",
            "description":"Total amount of work completed on a progress payment schedule, as shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the purchase order currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the period of performance for which the work confirmation is no longer active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoicedWithQualifier":{
            "title":"Invoiced",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount invoiced against the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Linenumberschedulenumber":{
            "title":"Line - Schedule",
            "maxLength":81,
            "type":"string",
            "description":"Line and schedule number for a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenToInvoiceWithQualifier":{
            "title":"Open to Invoice",
            "maxLength":255,
            "type":"string",
            "description":"Quantity or amount that hasn't been invoiced yet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderedQuantityWithQualifier":{
            "title":"Ordered Quantity",
            "maxLength":255,
            "type":"string",
            "description":"Total quantity ordered for this purchase order schedule shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderedWithQualifier":{
            "title":"Ordered",
            "maxLength":255,
            "type":"string",
            "description":"Total amount ordered for this purchase order schedule shown with the currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviouslyApprovedWithQualifier":{
            "title":"Previously Approved",
            "maxLength":255,
            "type":"string",
            "description":"Total approved work confirmation amount for a progress payment schedule, shown with the currency code, prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptId":{
            "type":"number",
            "description":"Value that uniquely identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "title":"Receipt",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedOn":{
            "title":"Received On",
            "type":"string",
            "description":"Date when the work confirmation is requested.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivedWithQualifier":{
            "title":"Received",
            "maxLength":255,
            "type":"string",
            "description":"Ordered quantity that has been received shown with the UOM code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Scheduledescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the period of performance for which the work confirmation becomes active.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalUnitsCompletedtoDateWithQualifier":{
            "title":"Total Units Completed to Date",
            "maxLength":255,
            "type":"string",
            "description":"Total units of work completed for a progress payment schedule, shown with the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure that the item uses for quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitsCompletedThisPeriodWithQualifier":{
            "title":"Units Completed This Period",
            "maxLength":255,
            "type":"string",
            "description":"Units of work completed on a progress payment schedule for a period of performance, shown with the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "title":"Work Confirmation",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation within a sold-to legal entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top