Jump to

• Request
• Response
• Examples

Get all work confirmations

get

/fscmRestApi/resources/11.13.18.05/workConfirmations

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 a work confirmation according to the work confirmation identifier as the primary key.
    Finder Variables:
    • WorkConfirmationId; integer; Value that uniquely identifies the work confirmation.
  • findByIntent: Finds a work confirmation according to the specified values.
    Finder Variables:
    • Intent; string; Value that uniquely identifies the intent. Valid value is Approver.
    • SysEffectiveDate; object.
• 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; Amount pending to complete the work on a purchase order.
  • Buyer; string; Person who is responsible for managing the purchase order.
  • BuyerId; integer; Value that uniquely identifies the buyer on the purchase order.
  • ContractAmountToDate; number; Ordered amount on the purchase order.
  • Currency; string; Currency of the purchase order.
  • CurrencyCode; string; Abbreviation that identifies the currency of the purchase order.
  • CurrentPaymentDue; number; Amount that needs be paid for a period of performance.
  • ImportSource; string; Value that indicates the source application from which the work confirmation was imported.
  • OrderNumber; string; Number that uniquely identifies the purchase order in a sold-to legal entity.
  • PODescription; string; Description of the purchase order.
  • POHeaderId; integer; Value that uniquely identifies the purchase order.
  • PeriodEndDate; string; Date when the period of performance for which work confirmation is no longer active.
  • PeriodStartDate; string; Date when the period of performance for which work confirmation becomes active.
  • PreviouslyApprovedAmount; number; Total approved work confirmation amount of a purchase order prior to the current period of performance.
  • ProjectedRetainageThisPeriod; number; Projected amount of retainage that can be withheld on the purchase order for a period of performance.
  • SoldToLegalEntity; string; Legal entity that is financially responsible for purchases on the purchase order.
  • SoldToLegalEntityId; integer; Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
  • Status; string; Status of the work confirmation.
  • StatusCode; string; Abbreviation that identifies the work confirmation status.
  • Supplier; string; Name of the supplier on the purchase order.
  • SupplierId; integer; Value that uniquely identifies the supplier on the purchase order.
  • SupplierSite; string; Location that the supplier uses to fulfill the purchase order.
  • SupplierSiteId; integer; Value that uniquely identifies the supplier site on the purchase order.
  • TotalCompletedThisPeriod; number; Total amount of work completed on a purchase order for a period of performance.
  • TotalCompletedToDate; number; Total amount of work completed on a purchase order.
  • WorkConfirmationId; integer; Value that uniquely identifies the work confirmation.
  • WorkConfirmationNumber; string; Number that uniquely identifies the work confirmation in a sold-to legal entity.
  • WorkConfirmationRequestDate; string; Date when the work confirmation is requested.
• 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

• Effective-Of: string
  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: 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 : 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/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."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object workConfirmations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/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 : workConfirmations-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The Attachments resource manages attachments for a work confirmation.
• BalanceToFinish: number
  Read Only: true

  Amount pending to complete the work on a purchase order.
• Buyer: string
  Title: Name

  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 on the purchase order.
• Comments: string
  Maximum Length: 240

  Comments entered for the work confirmation.
• ContractAmountToDate: number
  Read Only: true

  Ordered amount on the purchase order.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the work confirmation.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application created the work confirmation.
• Currency: string
  Title: Currency Name

  Read Only: true

  Maximum Length: 80

  Currency of the purchase order.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the currency of the purchase order.
• CurrentPaymentDue: number
  Read Only: true

  Amount that needs be paid for a period of performance.
• documentActions: array Document Actions
  Title: Document Actions

  The Document Actions resource retrieves the list of actions performed on a work confirmation.
• ImportSource: string
  Maximum Length: 25

  Value that indicates the source application from which the work confirmation was imported.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application most recently updated the work confirmation.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the work confirmation.
• lines: array Lines
  Title: Lines

  The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  Number that uniquely identifies the purchase order in a sold-to legal entity.
• PeriodEndDate: string (date)
  Date when the period of performance for which work confirmation is no longer active.
• PeriodStartDate: string (date)
  Date when the period of performance for which work confirmation becomes active.
• PODescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the purchase order.
• POHeaderId: integer (int64)
  Value that uniquely identifies the purchase order.
• PreviouslyApprovedAmount: number
  Read Only: true

  Total approved work confirmation amount of a purchase order prior to the current period of performance.
• ProjectedRetainageThisPeriod: number
  Read Only: true

  Projected amount of retainage that can be withheld on the purchase order for a period of performance.
• SoldToLegalEntity: string
  Title: Legal Entity Name

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 80

  Status of the work confirmation.
• StatusCode: string
  Read Only: true

  Maximum Length: 25

  Abbreviation that identifies the work confirmation status.
• Supplier: string
  Read Only: true

  Maximum Length: 360

  Name of the supplier on the purchase order.
• SupplierId: integer (int64)
  Read Only: true

  Value that uniquely identifies the supplier on the purchase order.
• SupplierSite: string
  Title: Site

  Read Only: true

  Maximum Length: 240

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

  Value that uniquely identifies the supplier site on the purchase order.
• TotalCompletedThisPeriod: number
  Read Only: true

  Total amount of work completed on a purchase order for a period of performance.
• TotalCompletedToDate: number
  Read Only: true

  Total amount of work completed on a purchase order.
• WorkConfirmationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work confirmation.
• WorkConfirmationNumber: string
  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the work confirmation in a sold-to legal entity.
• WorkConfirmationRequestDate: string (date-time)
  Date when the work confirmation is requested.
• WorkConfirmationSequenceNumber: integer (int64)
  Read Only: true

  Number that uniquely identifies the sequence of work confirmation on a purchase order.

{
    "type":"object",
    "properties":{
        "BalanceToFinish":{
            "type":"number",
            "description":"Amount pending to complete the work on a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Buyer":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Person who is responsible for managing the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BuyerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the buyer on the purchase order.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":240,
            "type":"string",
            "description":"Comments entered for the work confirmation.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractAmountToDate":{
            "type":"number",
            "description":"Ordered amount on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the supplier or application created the work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Currency":{
            "title":"Currency Name",
            "maxLength":80,
            "type":"string",
            "description":"Currency of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CurrentPaymentDue":{
            "type":"number",
            "description":"Amount that needs be paid for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImportSource":{
            "maxLength":25,
            "type":"string",
            "description":"Value that indicates the source application from which the work confirmation was imported.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier or application most recently updated the work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrderNumber":{
            "title":"Order",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the purchase order in a sold-to legal entity.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PODescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "type":"string",
            "description":"Date when the period of performance for which work confirmation is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodStartDate":{
            "type":"string",
            "description":"Date when the period of performance for which work confirmation becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PreviouslyApprovedAmount":{
            "type":"number",
            "description":"Total approved work confirmation amount of a purchase order prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectedRetainageThisPeriod":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the purchase order for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SoldToLegalEntity":{
            "title":"Legal Entity Name",
            "maxLength":240,
            "type":"string",
            "description":"Legal entity that is financially responsible for purchases on the purchase order.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "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,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Status of the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the work confirmation status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Supplier":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the supplier on the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Location that the supplier uses to fulfill the purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site on the purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCompletedThisPeriod":{
            "type":"number",
            "description":"Total amount of work completed on a purchase order for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCompletedToDate":{
            "type":"number",
            "description":"Total amount of work completed on a purchase order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation in a sold-to legal entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkConfirmationRequestDate":{
            "type":"string",
            "description":"Date when the work confirmation is requested.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "WorkConfirmationSequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of work confirmation on a purchase order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource manages attachments for a work confirmation.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-attachments-item-response"
            }
        },
        "documentActions":{
            "title":"Document Actions",
            "type":"array",
            "description":"The Document Actions resource retrieves the list of actions performed on a work confirmation.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-documentActions-item-response"
            }
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.",
            "items":{
                "$ref":"#/components/schemas/workConfirmations-lines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource manages attachments for a work confirmation.

Show Source

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

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource manages attachments for a work confirmation.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-attachments-item-response"
    }
}

Nested Schema : Document Actions

Type: array

Title: Document Actions

The Document Actions resource retrieves the list of actions performed on a work confirmation.

Show Source

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

{
    "title":"Document Actions",
    "type":"array",
    "description":"The Document Actions resource retrieves the list of actions performed on a work confirmation.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-documentActions-item-response"
    }
}

Nested Schema : Lines

Type: array

Title: Lines

The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.

Show Source

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

{
    "title":"Lines",
    "type":"array",
    "description":"The Lines resource manages work confirmation details, such as the total progress percent, quantity or amount of work completed for a period of performance.",
    "items":{
        "$ref":"#/components/schemas/workConfirmations-lines-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 : workConfirmations-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

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

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON-formatted string that contains information required to programmatically retrieve a large file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The Base64-encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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."
        }
    }
}

Nested Schema : workConfirmations-documentActions-item-response

Type: object

Show Source

• Action: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Name of the action performed on the work confirmation.
• ActionCode: string
  Maximum Length: 25

  Abbreviation that identifies the name of the action performed on the work confirmation. Valid values are submit, approve, reject, and withdraw.
• ActionDate: string (date-time)
  Date and time when the user performed an action.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who performed the action on work confirmation.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user performed the action on work confirmation.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user recently performed the action on work confirmation.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently performed the action on work confirmation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Note: string
  Maximum Length: 255

  Note that the user entered while performing an action.
• ObjectId: integer (int64)
  Value that uniquely identifies the work confirmation.
• PerformedByUserName: string
  Maximum Length: 255

  Person who has performed the action.
• PerformerId: integer
  Value that uniquely identifies the person who has performed the action.
• SequenceNumber: integer
  Number that uniquely identifies the sequence of an approval action performed on the work confirmation.

{
    "type":"object",
    "properties":{
        "Action":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Name of the action performed on the work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActionCode":{
            "maxLength":25,
            "type":"string",
            "description":"Abbreviation that identifies the name of the action performed on the work confirmation. Valid values are submit, approve, reject, and withdraw.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date and time when the user performed an action.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who performed the action on work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user performed the action on work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user recently performed the action on work confirmation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently performed the action on work confirmation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Note":{
            "maxLength":255,
            "type":"string",
            "description":"Note that the user entered while performing an action.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PerformedByUserName":{
            "maxLength":255,
            "type":"string",
            "description":"Person who has performed the action.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PerformerId"
                ]
            }
        },
        "PerformerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who has performed the action.",
            "nullable":true,
            "x-queryable":false
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the sequence of an approval action performed on the work confirmation.",
            "nullable":false,
            "x-queryable":false
        },
        "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 : workConfirmations-lines-item-response

Type: object

Show Source

• Amount: number
  Amount of work completed on a progress payment schedule for a period or performance.
• BalanceToFinish: number
  Read Only: true

  Amount pending to complete the work on a progress payment schedule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the work confirmation line.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application created the work confirmation line.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the supplier or application most recently updated the work confirmation line.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the work confirmation line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumRetainageAmount: number
  Title: Maximum Retainage Amount

  Read Only: true

  Maximum amount of retainage that can be withheld on a purchase order line.
• POLineId: integer (int64)
  Value that uniquely identifies the purchase order line.
• POLineLocationId: integer (int64)
  Value that uniquely identifies the purchase order schedule.
• POLineNumber: number
  Title: Line

  Number that uniquely identifies the purchase order line.
• POScheduleDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the work associated with the progress payment schedule.
• POScheduleNumber: number
  Title: Schedule

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

  Total approved work confirmation amount of a progress payment schedule prior to the current period of performance.
• Price: number
  Title: Price

  Read Only: true

  Price of the purchase order schedule.
• ProjectedRetainageThisPeriod: number
  Read Only: true

  Projected amount of retainage that can be withheld on the progress payment schedule for a period of performance.
• Quantity: number
  Quantity of work completed on a progress payment schedule for a period or performance.
• RetainageRate: number
  Title: Retainage Rate

  Read Only: true

  Percentage of the invoice value that can be withheld as retainage.
• ScheduledQuantity: number
  Title: Quantity

  Read Only: true

  Scheduled quantity of the progress payment schedule .
• ScheduledValue: number
  Read Only: true

  Ordered amount on the progress payment schedule.
• ScheduleType: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of the progress payment schedule.
• ScheduleTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the progress payment schedule type. Valid values are rate and lump sum.
• TotalCompleted: number
  Read Only: true

  Total amount of work completed on a progress payment schedule.
• TotalProgressPercent: number
  Value that indicates the percent of the work completed on a progress payment schedule.
• TotalProjectedRetainageToDate: number
  Read Only: true

  Projected amount of retainage that can be withheld on the progress payment schedule.
• UOM: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure for the quantity ordered on the purchase order schedule.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure on the purchase order schedule.
• WorkConfirmationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work confirmation.
• WorkConfirmationLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the work confirmation line.
• WorkConfirmationNumber: string
  Read Only: true

  Maximum Length: 30

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

{
    "type":"object",
    "properties":{
        "Amount":{
            "type":"number",
            "description":"Amount of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "BalanceToFinish":{
            "type":"number",
            "description":"Amount pending to complete the work on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the supplier or application created the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the supplier or application most recently updated the work confirmation line.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the work confirmation line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MaximumRetainageAmount":{
            "title":"Maximum Retainage Amount",
            "type":"number",
            "description":"Maximum amount of retainage that can be withheld on a purchase order line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "POLineLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order schedule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "POLineNumber":{
            "title":"Line",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "POScheduleDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the work associated with the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "POScheduleNumber":{
            "title":"Schedule",
            "type":"number",
            "description":"Number that uniquely identifies the purchase order schedule for the purchase order line.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PreviouslyApprovedAmount":{
            "type":"number",
            "description":"Total approved work confirmation amount of a progress payment schedule prior to the current period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Price":{
            "title":"Price",
            "type":"number",
            "description":"Price of the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectedRetainageThisPeriod":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule for a period of performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity of work completed on a progress payment schedule for a period or performance.",
            "nullable":true,
            "x-queryable":false
        },
        "RetainageRate":{
            "title":"Retainage Rate",
            "type":"number",
            "description":"Percentage of the invoice value that can be withheld as retainage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleType":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScheduleTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the progress payment schedule type. Valid values are rate and lump sum.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduledQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Scheduled quantity of the progress payment schedule .",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduledValue":{
            "type":"number",
            "description":"Ordered amount on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalCompleted":{
            "type":"number",
            "description":"Total amount of work completed on a progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalProgressPercent":{
            "type":"number",
            "description":"Value that indicates the percent of the work completed on a progress payment schedule.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalProjectedRetainageToDate":{
            "type":"number",
            "description":"Projected amount of retainage that can be withheld on the progress payment schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM Name",
            "maxLength":25,
            "type":"string",
            "description":"Unit of measure for the quantity ordered on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure on the purchase order schedule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkConfirmationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkConfirmationLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work confirmation line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkConfirmationNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the work confirmation in a sold-to legal entity.",
            "nullable":false,
            "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"
    }
}

Back to Top

Examples

This example describes how to get all work confirmations.

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/workConfirmations"

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "items": [
        {
            "WorkConfirmationId": 300100549276467,
            "WorkConfirmationNumber": "1005070-1",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": "2021-12-01",
            "PeriodEndDate": "2021-12-31",
            "WorkConfirmationRequestDate": "2022-01-03T00:00:00+00:00",
            "Comments": null,
            "StatusCode": "PENDING APPROVAL",
            "Status": "Pending Approval",
            "WorkConfirmationSequenceNumber": 1,
            "CreationDate": "2022-01-10T15:24:01+00:00",
            "CreatedBy": "CVSUPPA05",
            "LastUpdateDate": "2022-01-10T15:55:54+00:00",
            "LastUpdatedBy": "CVSUPPA05",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 0,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 7000,
            "TotalCompletedToDate": 7000,
            "ProjectedRetainageThisPeriod": 700,
            "CurrentPaymentDue": 6300,
            "BalanceToFinish": 243000,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549930767,
            "WorkConfirmationNumber": "1005070-6",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": "2021-12-01",
            "PeriodEndDate": "2021-12-31",
            "WorkConfirmationRequestDate": "2022-01-01T00:00:00+00:00",
            "Comments": null,
            "StatusCode": "APPROVED",
            "Status": "Approved",
            "WorkConfirmationSequenceNumber": 6,
            "CreationDate": "2022-01-17T06:08:52+00:00",
            "CreatedBy": "CVSUPPA05",
            "LastUpdateDate": "2022-01-17T10:21:03+00:00",
            "LastUpdatedBy": "CVSUPPA05",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 9200,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 1000,
            "TotalCompletedToDate": 10200,
            "ProjectedRetainageThisPeriod": 100,
            "CurrentPaymentDue": 900,
            "BalanceToFinish": 239800,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930767/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549714000,
            "WorkConfirmationNumber": "1005070-2",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": null,
            "PeriodEndDate": null,
            "WorkConfirmationRequestDate": "2022-01-13T04:50:44+00:00",
            "Comments": null,
            "StatusCode": "APPROVED",
            "Status": "Approved",
            "WorkConfirmationSequenceNumber": 2,
            "CreationDate": "2022-01-13T16:50:43+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdateDate": "2022-01-13T16:51:28+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 0,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 4000,
            "TotalCompletedToDate": 4000,
            "ProjectedRetainageThisPeriod": 400,
            "CurrentPaymentDue": 3600,
            "BalanceToFinish": 246000,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549714000/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549976372,
            "WorkConfirmationNumber": "1005070-11",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": null,
            "PeriodEndDate": null,
            "WorkConfirmationRequestDate": "2022-01-17T00:00:00+00:00",
            "Comments": null,
            "StatusCode": "APPROVED",
            "Status": "Approved",
            "WorkConfirmationSequenceNumber": 11,
            "CreationDate": "2022-01-17T10:18:27+00:00",
            "CreatedBy": "CVRQST10",
            "LastUpdateDate": "2022-01-17T10:19:38+00:00",
            "LastUpdatedBy": "CVRQST10",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 8200,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 1000,
            "TotalCompletedToDate": 9200,
            "ProjectedRetainageThisPeriod": 100,
            "CurrentPaymentDue": 900,
            "BalanceToFinish": 240800,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549976372/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549930856,
            "WorkConfirmationNumber": "1005070-8",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": null,
            "PeriodEndDate": null,
            "WorkConfirmationRequestDate": "2022-01-17T06:20:36+00:00",
            "Comments": null,
            "StatusCode": "CANCELED",
            "Status": "Canceled",
            "WorkConfirmationSequenceNumber": 8,
            "CreationDate": "2022-01-17T06:20:35+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdateDate": "2022-01-31T18:41:51+00:00",
            "LastUpdatedBy": "CVRQST10",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 10200,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 1000,
            "TotalCompletedToDate": 11200,
            "ProjectedRetainageThisPeriod": 100,
            "CurrentPaymentDue": 900,
            "BalanceToFinish": 238800,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549930856/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549793090,
            "WorkConfirmationNumber": "1005070-3",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": null,
            "PeriodEndDate": null,
            "WorkConfirmationRequestDate": "2022-01-14T07:07:30+00:00",
            "Comments": null,
            "StatusCode": "APPROVED",
            "Status": "Approved",
            "WorkConfirmationSequenceNumber": 3,
            "CreationDate": "2022-01-14T07:07:27+00:00",
            "CreatedBy": "CVBUYER01",
            "LastUpdateDate": "2022-01-14T07:12:12+00:00",
            "LastUpdatedBy": "CVBUYER01",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 4000,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 2200,
            "TotalCompletedToDate": 6200,
            "ProjectedRetainageThisPeriod": 220,
            "CurrentPaymentDue": 1980,
            "BalanceToFinish": 243800,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549793090/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        },
        {
            "WorkConfirmationId": 300100549798204,
            "WorkConfirmationNumber": "1005070-4",
            "POHeaderId": 300100549056643,
            "OrderNumber": "1005070",
            "SoldToLegalEntityId": 204,
            "SoldToLegalEntity": "Vision Operations",
            "PeriodStartDate": null,
            "PeriodEndDate": null,
            "WorkConfirmationRequestDate": "2022-01-14T00:00:00+00:00",
            "Comments": null,
            "StatusCode": "APPROVED",
            "Status": "Approved",
            "WorkConfirmationSequenceNumber": 4,
            "CreationDate": "2022-01-14T08:58:32+00:00",
            "CreatedBy": "CVBUYER03",
            "LastUpdateDate": "2022-01-14T08:59:32+00:00",
            "LastUpdatedBy": "CVBUYER03",
            "PODescription": "Contract for renovation of parking lot",
            "SupplierId": 1717,
            "Supplier": "CV_SuppA05",
            "SupplierSiteId": 4060,
            "SupplierSite": "CVSuppA05Site01",
            "CurrencyCode": "USD",
            "Currency": "US Dollar",
            "ImportSource": null,
            "PreviouslyApprovedAmount": 6200,
            "ContractAmountToDate": 250000,
            "TotalCompletedThisPeriod": 2000,
            "TotalCompletedToDate": 8200,
            "ProjectedRetainageThisPeriod": 200,
            "CurrentPaymentDue": 1800,
            "BalanceToFinish": 241800,
            "BuyerId": 100010026863799,
            "Buyer": "Norden,Loraine",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204",
                    "name": "workConfirmations",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204",
                    "name": "workConfirmations",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/child/attachments",
                    "name": "attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/child/documentActions",
                    "name": "documentActions",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/child/lines",
                    "name": "lines",
                    "kind": "collection"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/action/withdraw",
                    "name": "withdraw",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/action/cancel",
                    "name": "cancel",
                    "kind": "other"
                },
                {
                    "rel": "action",
                    "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549798204/action/submit",
                    "name": "submit",
                    "kind": "other"
                }
            ]
        }
    ],
    "count": 7,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/workConfirmations",
            "name": "workConfirmations",
            "kind": "collection"
        }
    ]
}

Back to Top