v1/containers/{containerId}/schedule-of-values
Creates a new schedule of values (SOV) item for the given project. When parentId is provided, the request creates a child SOV item under the existing parent. When parentId is omitted or null, the request creates a root SOV item and requires budgetId, contractId, the sovBudgetMultipleLink setting to be enabled, and an existing budget-linked SOV with the same budgetId and contractId.
Resource Information
| Method and URI | POST https://developer.api.autodesk.com/cost/v1/containers/:containerId/schedule-of-values |
| Authentication Context | User context required |
| Required OAuth Scopes | data:write |
| Data Format | JSON |
Request
Headers
| Authorization* string | Must be Bearer <token>, where <token> is a three-legged access token obtained via an Authorization Code flow or a Secure Service Account (SSA) flow.
The SSA flow is designed for headless server-to-server operations. While it functions like a two-legged flow (no user interaction), it is classified as three-legged because it preserves user context. |
| Content-Type* string | Must be application/json |
| region string | Specifies the region where the project data resides.
By default, the request is routed automatically. However, specifying the region can improve performance by avoiding lookup overhead. Possible values: country or region codes such as To verify your project’s region, refer to the Working with BIM 360 Services in Different Regions section on the API Basics page. |
Request
URI Parameters
| containerId string: UUID | The ID of the project (the container ID is the same as the project ID). To obtain the project ID, see GET projects. |
Request
Body Structure
The schedule of value.
| id string: UUID | The unique ID of this SOV item. |
| parentId string,null | The ID of the SOV item’s parent item. For root SOV items, this value is null. When omitted or set to null, the request creates a root SOV item and requires budgetId, contractId, the sovBudgetMultipleLink setting to be enabled, and the budget to be linked to the contract. |
| contractId string | The ID of the contract to which the SOV item belongs. Required when creating a root SOV item. Child SOV items inherit this value from the parent. |
| budgetId string,null | The ID of the budget to which the SOV item belongs. Required when creating a root SOV item. Child SOV items inherit this value from the parent. |
| code* string | The code of the SOV item.
Max length: 255 |
| name* string | The name of the SOV item.
Max length: 1024 |
| quantity number | The quantity of the SOV item. |
| unitPrice number | The unit price of the SOV item. |
| unit string | The unit of measure of the SOV item.
Max length: 1024 |
| amount number,string,null | The total price of the SOV item. |
| quantityPerBulk number | The quantity conversion ratio of the SOV item. |
| bulkUnitPrice number | The unit price of the converted SOV item quantity. |
| bulk number | The converted quantity of the SOV item. |
| exchangeRate number,string,null | The exchange rate that applies to the SOV item’s base currency price. For example, provide the value 0.7455 for a foreign currency that’s worth 0.7455 of your base currency. |
| position number | The position of the SOV item in the list of SOV items. |
| externalId string | The identifier assigned to an item in its original external ERP system. Use this ID to track and look up data within the integrated system. Note that this value comes from the item’s ID in the external system.
Max length: 255 |
| externalSystem string | The name of the external ERP system integrated with Cost Management. Use this name to identify and search for data within the integrated system.
Max length: 255 |
| externalMessage string | A message generated by the external ERP system that explains the sync status of the integration. For example, common values include success or fail to indicate the result of the integration operation.
Max length: 255 |
| lastSyncTime datetime: ISO 8601 | The date and time when the item was last synchronized with the external ERP system. This value is updated by the external system and is in ISO 8601 format. |
Response
HTTP Status Code Summary
| 201 Created | Created |
| 400 Bad Request | The parameters are invalid. |
| 401 Unauthorized | The provided bearer token is invalid. |
| 403 Forbidden | Forbidden. The user or service represented by the bearer token does not have permission to perform this operation. |
| 404 Not Found | The resource or endpoint cannot be found. |
| 409 Conflict | The request could not be completed due to a conflict with the current state of the resource. |
| 429 Too Many Requests | Rate limit exceeded. Retry your request after a few minutes. |
| 500 Internal Server Error | An unexpected error occurred on the server. |
| 503 Service Unavailable | Service unavailable. |
Response
Body Structure (201)
| id string: UUID | The unique ID of this SOV item. |
| parentId string,null | The ID of the SOV item’s parent item. For root SOV items, this value is null. When omitted or set to null, the request creates a root SOV item and requires budgetId, contractId, the sovBudgetMultipleLink setting to be enabled, and the budget to be linked to the contract. |
| contractId string | The ID of the contract to which the SOV item belongs. Required when creating a root SOV item. Child SOV items inherit this value from the parent. |
| budgetId string,null | The ID of the budget to which the SOV item belongs. Required when creating a root SOV item. Child SOV items inherit this value from the parent. |
| code string | The code of the SOV item.
Max length: 255 |
| name string | The name of the SOV item.
Max length: 1024 |
| quantity number | The quantity of the SOV item. |
| unitPrice number | The unit price of the SOV item. |
| unit string | The unit of measure of the SOV item.
Max length: 1024 |
| amount number,string,null | The total price of the SOV item. |
| quantityPerBulk number | The quantity conversion ratio of the SOV item. |
| bulkUnitPrice number | The unit price of the converted SOV item quantity. |
| bulk number | The converted quantity of the SOV item. |
| associationId string,null | The ID of a change order or cost item that this SOV item was originally created from. |
| associationType string,null | The type of object from which the SOV item was created:a change order or a cost item. |
| exchangeRate number,string,null | The exchange rate that applies to the SOV item’s base currency price. For example, provide the value 0.7455 for a foreign currency that’s worth 0.7455 of your base currency. |
| position number | The position of the SOV item in the list of SOV items. |
| createdAt datetime: ISO 8601 | The date and time that the item was created, in ISO 8601 format. |
| updatedAt datetime: ISO 8601 | The date and time that the item was last updated, in ISO 8601 format. |
| externalId string | The identifier assigned to an item in its original external ERP system. Use this ID to track and look up data within the integrated system. Note that this value comes from the item’s ID in the external system.
Max length: 255 |
| externalSystem string | The name of the external ERP system integrated with Cost Management. Use this name to identify and search for data within the integrated system.
Max length: 255 |
| externalMessage string | A message generated by the external ERP system that explains the sync status of the integration. For example, common values include success or fail to indicate the result of the integration operation.
Max length: 255 |
| lastSyncTime datetime: ISO 8601 | The date and time when the item was last synchronized with the external ERP system. This value is updated by the external system and is in ISO 8601 format. |
| bridgeInfo object,null | Not relevant |
Example
Created
Request
curl -v 'https://developer.api.autodesk.com/cost/v1/containers/e94b9bc8-1775-4d76-9b1d-c613e120ccff/schedule-of-values' \
-X 'POST' \
-H 'Authorization: Bearer AuIPTf4KYLTYGVnOHQ0cuolwCW2a' \
-H 'Content-Type: application/json' \
-d '{
"id": "88dc0f70-9483-11e8-a7ec-7ddae203e404",
"parentId": "76b8e1b8-14a7-4dbe-b406-b4f0c0f86df6",
"contractId": "2256dc50-9481-11e8-87fb-215990a8aeb3",
"budgetId": "f6445638-ca68-4e3c-9160-15864de6b818",
"code": "03 30 01.1",
"name": "Concrete to Pile Caps",
"quantity": 50,
"unitPrice": 20,
"unit": "ea",
"amount": "1000.0000",
"quantityPerBulk": 50,
"bulkUnitPrice": 20,
"bulk": 50,
"exchangeRate": "1000.0000",
"position": 1,
"externalId": "10010-99-AB",
"externalSystem": "Sage300",
"externalMessage": "Success.",
"lastSyncTime": "2019-09-05T01:00:12.989Z"
}'
Response
{
"id": "88dc0f70-9483-11e8-a7ec-7ddae203e404",
"parentId": "76b8e1b8-14a7-4dbe-b406-b4f0c0f86df6",
"contractId": "2256dc50-9481-11e8-87fb-215990a8aeb3",
"budgetId": "f6445638-ca68-4e3c-9160-15864de6b818",
"code": "03 30 01.1",
"name": "Concrete to Pile Caps",
"quantity": 50,
"unitPrice": 20,
"unit": "ea",
"amount": "1000.0000",
"quantityPerBulk": 50,
"bulkUnitPrice": 20,
"bulk": 50,
"associationId": "88dc0f70-9483-11e8-a7ec-7ddae203e404",
"associationType": "SCO",
"exchangeRate": "1000.0000",
"position": 1,
"createdAt": "2019-01-06T01:24:22.678Z",
"updatedAt": "2019-09-05T01:00:12.989Z",
"externalId": "10010-99-AB",
"externalSystem": "Sage300",
"externalMessage": "Success.",
"lastSyncTime": "2019-09-05T01:00:12.989Z",
"bridgeInfo": ""
}