createBidCostSheet

Requires permission biddesk:cost_sheet:edit.

Starts the bid's next cost sheet (v1, v2, …) for a frozen configuration, against the published cost model, with one line per item of the snapshot and no costs yet. Refused with CONFIGURATION_NOT_FROZEN or COST_MODEL_MISSING. Requires Bid Desk and permission to edit 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

mutation CreateBidCostSheet($input: CreateBidCostSheetInput!) {
  createBidCostSheet(input: $input) {
    id
    status
    approvedAt
    approvedBy
    bidId
    configurationId
    lines {
      id
      costCurrency
      description
      evidence
      fxRate
      kind
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CreateBidCostSheet($input: CreateBidCostSheetInput!) {\n  createBidCostSheet(input: $input) {\n    id\n    status\n    approvedAt\n    approvedBy\n    bidId\n    configurationId\n    lines {\n      id\n      costCurrency\n      description\n      evidence\n      fxRate\n      kind\n    }\n  }\n}",
  "variables": {
    "input": {
      "bidId": "id",
      "configurationId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "bidId": "id",
    "configurationId": "id"
  }
}

Response:

{
  "data": {
    "createBidCostSheet": {
      "id": "id",
      "status": "APPROVED",
      "approvedAt": "2025-01-15T00:00:00Z",
      "approvedBy": "id",
      "bidId": "id",
      "configurationId": "id",
      "lines": [
        {
          "id": "id",
          "costCurrency": "string",
          "description": "string",
          "evidence": {},
          "fxRate": "string",
          "kind": "COMMISSIONING"
        }
      ]
    }
  }
}

createBidCostSheet(
  input: CreateBidCostSheetInput!
): BidCostSheet!

Arguments

createBidCostSheet.input ● CreateBidCostSheetInput! non-null input

The bid and its frozen configuration.

Type

BidCostSheet object

One cost sheet of a bid (v1, v2, …): the frozen configuration snapshot it costs, the cost model version it is costed against, and its lines. Totals are not computed here.