withdrawBidCostSheet

Requires permission biddesk:cost_sheet:submit.

Takes a submitted, not yet approved cost sheet back to draft. Refused with COST_SHEET_LOCKED when it is not submitted, VERSION_CONFLICT when someone changed it first. Requires Bid Desk and permission to submit 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 WithdrawBidCostSheet($input: BidCostSheetVersionInput!) {
  withdrawBidCostSheet(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 WithdrawBidCostSheet($input: BidCostSheetVersionInput!) {\n  withdrawBidCostSheet(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": {
      "expectedVersion": 0,
      "id": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "expectedVersion": 0,
    "id": "id"
  }
}

Response:

{
  "data": {
    "withdrawBidCostSheet": {
      "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"
        }
      ]
    }
  }
}

withdrawBidCostSheet(
  input: BidCostSheetVersionInput!
): BidCostSheet!

Arguments

withdrawBidCostSheet.input ● BidCostSheetVersionInput! non-null input

The sheet and its version.

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.