This API updates the details of a Schedule Of Value (SOV) for a purchase order in a project of Smart materials. These values are an important part of agreements or purchase orders.
You cannot update schedule of values, if ReadyForApprovalInd in the related agreement is set to Y.
Required Privilege: API_AGREEMENT
Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/JSON |
Body
URL Format: PUT/PATCH https://{host}/Smat/V1/Projects(':project')/Disciplines(':discipline')/Nls(':language')/PurcahseOrders(':key1')/ScheduleOfvalues(':key2')
Specify values for the project, discipline, language, and key parameters in the URL. The project, discipline, and language together, define the project environment. The key1 parameter defines the purchase order ID (PohId) and key2 defines the schedule of values ID (ApbId).
While using PUT method, if value is not passed for these elements in SOV and labor
hours, the application will use the default value as updated value. However, in PATCH
method, the application considers the previous available values and not the default
one. Elements are MaterialTotal, ConstructEquipTotal, ConsumablesTotal, and OthersTotal
in SOV and Hours and RateUnit in Labor hours.
Schedule of values elements
|
Element |
Description |
Type |
Required |
|---|---|---|---|
|
Description |
Description of the item attached with the schedule of value. |
String |
Required |
|
PoliId |
Unique ID of the position item that belongs to the current agreement |
Integer |
Optional |
|
ActivityCode |
Name (code) of the activity related to this item. |
String |
Optional |
|
AccountCode |
Account code related to this item. |
String |
Optional |
|
MaterialTotal |
Refers to the estimated cost of the material.
|
Integer |
Optional |
|
ConstructEquipTotal |
Estimated cost for the construction equipment. |
Integer |
Optional |
|
ConsumablesTotal |
Estimated cost for the consumables. |
Integer |
Optional |
|
OthersTotal |
Estimated cost that could not be added to the material, construction equipment, or consumables totals. |
Integer |
Optional |
|
Comments |
Additional comments given for the item. |
String |
Optional |
|
Currency |
Currency name (code) used for the price breakdown structure or item.
|
String |
Optional |
Material means those materials that enter directly into the end product, or that
are used or consumed directly in connection with the furnishing of the end product
or service.
Labor hours elements
|
Element |
Description |
Type |
Required |
|---|---|---|---|
|
AlhId |
Unique ID of the labor hours classification. |
Integer |
Required |
|
OrderSeq |
Order sequence for the labor hours classification
|
Integer |
Required |
|
LaborClassification |
Refers to the labor classification.
|
String |
Required |
|
Hours |
Refers to the estimated number of direct labor hours. |
Integer |
Optional |
|
RateUnit |
Hourly rate of the selected labor classification. The total of the labor hours item is computed by multiplying the hourly rate by the number of estimated labor hours. |
Integer |
Optional |
Sample Code
PUT http://localhost: 58201/SMAT/V1/Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000076955)/scheduleofvalues(10000179201)
{
{
"Description": "description_like_some_5",
"MaterialTotal": 22,
"ConstructEquipTotal": 12,
"ConsumerTotal": 2,
"OthersTotal": 1,
"Comments": "Comments@123",
"Currency": "KNIKHIL",
"LaborHours" : [
{
"AlhId" : 10000119227,
"OrderSeq" : 2,
"LaborClassification": "KNIK" ,
"Hours": 2,
"RateUnit": 2
},
{
"AlhId": 10000119147,
"OrderSeq": 1,
"LaborClassification": "jalapino",
"Hours": 1,
"RateUnit": 2
}
]
}
Success Response
{
"@odata.context": "http://localhost:57101/SMAT/V1/$metadata#Projects('RS')/Disciplines('PIPING')/Nls('English')/PurchaseOrders(10000076955)/ScheduleOfValues/$entity",
"ApbId": 10000179201,
"ProjId": "RS",
"PkId": 10000076955,
"PkType": "POH",
"ItemCode": "NIKHILK",
"Description": "description_like_some_5",
"PoliId": null,
"Position": null,
"SubPosition": null,
"ActivityCode": null,
"AccountCode": null,
"MaterialTotal": 22,
"ConstructEquipTotal": 12,
"LaborHoursTotal": 6,
"ConsumerTotal": 2,
"OthersTotal": 1,
"OverallTotal": 86,
"Comments": "Comments@123",
"Currency": "KNIKHIL",
"LaborHours": [
{
"AlhId": 10000119147,
"ApbId": 10000179201,
"OrderSeq": 1,
"LaborClassification": "jalapino",
"Hours": 1,
"RateUnit": 2,
"Total": 2,
"Currency": "KNIKHIL"
},
{
"AlhId": 10000119227,
"ApbId": 10000179201,
"OrderSeq": 2,
"LaborClassification": "KNIK",
"Hours": 2,
"RateUnit": 2,
"Total": 4,
"Currency": "KNIKHIL"
}
]
}
Schedule of values elements
|
Element |
Description |
Type |
|---|---|---|
|
PkId |
Unique ID of the module to which the given Schedule Of value belongs |
Integer |
|
PkType |
Type of the price breakdown. |
String |
|
ItemCode |
Name (code) of the item attached with the schedule of value. |
String |
|
Position |
Position of an available line item of the actual agreement. A list of values are available. |
Integer |
|
SubPosition |
Sub Position of an available line item of the actual agreement. A list of values are available. |
Integer |
|
LaborHoursTotal |
Refers to the sum of hours * unit rate for all details of the price breakdown items. |
Integer |
|
OverallTotal |
Refers to the sum of all total fields present in the price breakdown item. It includes material total + labor total+construction equipment total + consumables total + other total. |
Integer |
|
LaborHours |
Refers to labor hours details. |
Collection |
Labor hours elements
|
Element |
Description |
Type |
|---|---|---|
|
Currency |
Currency of the labor hours item. |
String |
|
Total |
Refers to the calculated hours * unit rate. |
Integer |