Skip to content
Vellum

Costs endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/costs

Section titled “GET /api/projects/{projectId}/costs”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
200 OK CostSheetDto

POST /api/projects/{projectId}/costs/copy

Section titled “POST /api/projects/{projectId}/costs/copy”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): CopySheetRequest

Field Type Required Notes
from string yes
Status Meaning Body
200 OK CostSheetDto

POST /api/projects/{projectId}/costs/resources

Section titled “POST /api/projects/{projectId}/costs/resources”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): ResourceRequest

Field Type Required Notes
id string (uuid) or null yes
elementId string (uuid) yes
name string yes
category string yes
provider string yes
region string or null yes
sku string or null yes
quantity number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit string or null yes
priceRef string (uuid) or null yes
usage array of UsageLineRequest or null yes
factStatus string or null yes
provenance null or ProvenanceInput yes
Status Meaning Body
201 Created CostSheetDto

PUT /api/projects/{projectId}/costs/resources/{resourceId}

Section titled “PUT /api/projects/{projectId}/costs/resources/{resourceId}”
Parameter In Type Required
projectId path string (uuid) yes
resourceId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): ResourceRequest

Field Type Required Notes
id string (uuid) or null yes
elementId string (uuid) yes
name string yes
category string yes
provider string yes
region string or null yes
sku string or null yes
quantity number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit string or null yes
priceRef string (uuid) or null yes
usage array of UsageLineRequest or null yes
factStatus string or null yes
provenance null or ProvenanceInput yes
Status Meaning Body
200 OK CostSheetDto

DELETE /api/projects/{projectId}/costs/resources/{resourceId}

Section titled “DELETE /api/projects/{projectId}/costs/resources/{resourceId}”
Parameter In Type Required
projectId path string (uuid) yes
resourceId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
200 OK CostSheetDto

POST /api/projects/{projectId}/costs/assumptions

Section titled “POST /api/projects/{projectId}/costs/assumptions”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): AssumptionRequest

Field Type Required Notes
id string (uuid) or null yes
name string yes
kind string yes
subjectId string (uuid) or null yes
value number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit string yes
label string yes
source string or null yes
effectiveDate string (date) yes
Status Meaning Body
201 Created CostSheetDto

PUT /api/projects/{projectId}/costs/assumptions/{assumptionId}

Section titled “PUT /api/projects/{projectId}/costs/assumptions/{assumptionId}”
Parameter In Type Required
projectId path string (uuid) yes
assumptionId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): AssumptionRequest

Field Type Required Notes
id string (uuid) or null yes
name string yes
kind string yes
subjectId string (uuid) or null yes
value number (double) or string (double) or null yes pattern "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$"
unit string yes
label string yes
source string or null yes
effectiveDate string (date) yes
Status Meaning Body
200 OK CostSheetDto

DELETE /api/projects/{projectId}/costs/assumptions/{assumptionId}

Section titled “DELETE /api/projects/{projectId}/costs/assumptions/{assumptionId}”
Parameter In Type Required
projectId path string (uuid) yes
assumptionId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
200 OK CostSheetDto

GET /api/projects/{projectId}/costs/estimate

Section titled “GET /api/projects/{projectId}/costs/estimate”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no
asOf query string (date) no
Status Meaning Body
200 OK EstimateDto

GET /api/projects/{projectId}/costs/compare

Section titled “GET /api/projects/{projectId}/costs/compare”
Parameter In Type Required
projectId path string (uuid) yes
left query string no
right query string no
asOf query string (date) no
Status Meaning Body
200 OK ComparisonDto

GET /api/projects/{projectId}/costs/estimates

Section titled “GET /api/projects/{projectId}/costs/estimates”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
200 OK array of SavedEstimateDto

POST /api/projects/{projectId}/costs/estimates

Section titled “POST /api/projects/{projectId}/costs/estimates”
Parameter In Type Required
projectId path string (uuid) yes
branchId query string (uuid) no

Request body (application/json): SaveEstimateRequest

Field Type Required Notes
name string or null yes
asOf string (date) or null yes
Status Meaning Body
201 Created SavedEstimateDto

GET /api/projects/{projectId}/costs/estimates/{estimateId}

Section titled “GET /api/projects/{projectId}/costs/estimates/{estimateId}”
Parameter In Type Required
projectId path string (uuid) yes
estimateId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
200 OK SavedEstimateDto

DELETE /api/projects/{projectId}/costs/estimates/{estimateId}

Section titled “DELETE /api/projects/{projectId}/costs/estimates/{estimateId}”
Parameter In Type Required
projectId path string (uuid) yes
estimateId path string (uuid) yes
branchId query string (uuid) no
Status Meaning Body
204 No Content none

GET /api/projects/{projectId}/costs/prices

Section titled “GET /api/projects/{projectId}/costs/prices”
Parameter In Type Required
projectId path string (uuid) yes
Status Meaning Body
200 OK ProjectPricesDto

PUT /api/projects/{projectId}/costs/pins/{priceId}

Section titled “PUT /api/projects/{projectId}/costs/pins/{priceId}”
Parameter In Type Required
projectId path string (uuid) yes
priceId path string (uuid) yes
Status Meaning Body
204 No Content none

DELETE /api/projects/{projectId}/costs/pins/{priceId}

Section titled “DELETE /api/projects/{projectId}/costs/pins/{priceId}”
Parameter In Type Required
projectId path string (uuid) yes
priceId path string (uuid) yes
Status Meaning Body
204 No Content none