Create a work confirmation line
/fscmRestApi/resources/11.13.18.05/workConfirmations/{workConfirmationsUniqID}/child/lines
Request
-
workConfirmationsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Work Confirmations resource and used to uniquely identify an instance of Work Confirmations. The client should not generate the hash key value. Instead, the client should query on the Work Confirmations collection resource in order to navigate to a specific instance of Work Confirmations to get the hash key.
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
Amount: number
Amount of work completed on a progress payment schedule for a period or performance.
-
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. -
POScheduleNumber: number
Title:
Schedule
Number that uniquely identifies the purchase order schedule for the purchase order line. -
Quantity: number
Quantity of work completed on a progress payment schedule for a period or performance.
-
TotalProgressPercent: number
Value that indicates the percent of the work completed on a progress payment schedule.
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following examples describe how to create a work confirmation line.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username: password -X POST -H "Content-Type: application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/workConfirmations/WorkConfirmationUniqId/child/lines"
Examples
Example 1
In this example, a work confirmation line is created for a lumpsum schedule by providing a value for the amount attribute.
Example 1 Request Body
The following example includes the contents of the request body in JSON format.
"{ "POLineNumber": 1, "POScheduleNumber": 2, "Amount": 5000, }"
Example 1 Response Body
{ "WorkConfirmationLineId": 300100549276468, "WorkConfirmationId": 300100549276467, "POLineLocationId": 300100549072283, "Amount": 5000, "Quantity": null, "TotalProgressPercent": 50, "POLineId": 300100549056644, "POScheduleNumber": 2, "WorkConfirmationNumber": "1005070-1", "POLineNumber": 1, "CreationDate": "2022-01-10T15:24:03+00:00", "CreatedBy": "CVSUPPA05", "LastUpdateDate": "2022-01-10T15:47:26+00:00", "LastUpdatedBy": "CVSUPPA05", "POScheduleDescription": "Road Work", "UOMCode": null, "UOM": null, "ScheduleTypeCode": "LUMPSUM", "ScheduleType": "Lump Sum", "PreviouslyApprovedAmount": 0, "ProjectedRetainageThisPeriod": 500, "ScheduledValue": 10000, "TotalProjectedRetainageToDate": 500, "TotalCompleted": 5000, "BalanceToFinish": 5000, "Price": null, "MaximumRetainageAmount": 10000, "RetainageRate": 10, "ScheduledQuantity": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276468", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276468", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467", "name": "workConfirmations", "kind": "item" } ] }
Example 2
In this example, a work confirmation line is created for a rate-based schedule by providing a value for the quantity attribute.
Example 2 Request Body
The following example includes the contents of the request body in JSON format.
"{ "POLineNumber": 1, "POScheduleNumber": 1, "Quantity": 100, }"
Example 2 Response Body
{ "WorkConfirmationLineId": 300100549276469, "WorkConfirmationId": 300100549276467, "POLineLocationId": 300100549072275, "Amount": 1000, "Quantity": 100, "TotalProgressPercent": 10, "POLineId": 300100549056644, "POScheduleNumber": 1, "WorkConfirmationNumber": "1005070-1", "POLineNumber": 1, "CreationDate": "2022-01-10T15:24:03.039+00:00", "CreatedBy": "CVSUPPA05", "LastUpdateDate": "2022-01-10T15:24:03.103+00:00", "LastUpdatedBy": "CVSUPPA05", "POScheduleDescription": "Land scaping work - Floor 2", "UOMCode": null, "UOM": null, "ScheduleTypeCode": "LUMPSUM", "ScheduleType": "Lump Sum", "PreviouslyApprovedAmount": 0, "ProjectedRetainageThisPeriod": 100, "ScheduledValue": 10000, "TotalProjectedRetainageToDate": 100, "TotalCompleted": 1000, "BalanceToFinish": 9000, "Price": 10, "MaximumRetainageAmount": 10000, "RetainageRate": 10, "ScheduledQuantity": 1000, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276469", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276469", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467", "name": "workConfirmations", "kind": "item" } ] }
Example 3
In this example, a work confirmation line is created for a progress payment schedule by providing a value for the total progress percent attribute.
Example 3 Request Body
"{ "POLineNumber": 1, "POScheduleNumber": 3, "TotalProgressPercent": 10, }"
Example 3 Response Body
{ "WorkConfirmationLineId": 300100549276470, "WorkConfirmationId": 300100549276467, "POLineLocationId": 300100549056645, "Amount": 1000, "Quantity": null, "TotalProgressPercent": 10, "POLineId": 300100549056644, "POScheduleNumber": 3, "WorkConfirmationNumber": "1005070-1", "POLineNumber": 1, "CreationDate": "2022-01-10T15:24:03.081+00:00", "CreatedBy": "CVSUPPA05", "LastUpdateDate": "2022-01-10T15:24:03.106+00:00", "LastUpdatedBy": "CVSUPPA05", "POScheduleDescription": "Renovation of Parking Lot -Down payment", "UOMCode": null, "UOM": null, "ScheduleTypeCode": "LUMPSUM", "ScheduleType": "Lump Sum", "PreviouslyApprovedAmount": 0, "ProjectedRetainageThisPeriod": 100, "ScheduledValue": 10000, "TotalProjectedRetainageToDate": 100, "TotalCompleted": 1000, "BalanceToFinish": 9000, "Price": null, "MaximumRetainageAmount": 10000, "RetainageRate": 10, "ScheduledQuantity": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276470", "name": "lines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467/child/lines/300100549276470", "name": "lines", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/workConfirmations/300100549276467", "name": "workConfirmations", "kind": "item" } ] }