bidCostModel

Requires permission biddesk:cost_sheet:read.

The organization's published cost model, the version new cost sheets use; null when none is published. Its rates are null without permission to view costs. Requires Bid Desk and permission to read cost sheets.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query BidCostModel {
  bidCostModel {
    id
    status
    body
    currency
    modelVersion
    publishedAt
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidCostModel {\n  bidCostModel {\n    id\n    status\n    body\n    currency\n    modelVersion\n    publishedAt\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bidCostModel": {
      "id": "id",
      "status": "DRAFT",
      "body": {},
      "currency": "string",
      "modelVersion": 0,
      "publishedAt": "2025-01-15T00:00:00Z"
    }
  }
}

bidCostModel: BidCostModelVersion

Type

BidCostModelVersion object

One version of the organization's Bid Desk cost model: labour rates by skill, overhead, contingency by risk tag, freight, packing, installation, commissioning and travel day rates, warranty and financing. A published version never changes.