bidCommercialSummary

Requires permission biddesk:bid:read.

What a bid's commercial tab shows: its pricing terms, and from the cost sheet in force the price, the margin and markup it implies and each payment milestone's amount, all from the roll-up engine. The total cost is null without permission to view costs; the price, margin, markup and amounts are null without permission to view margins (and costs). Requires Bid Desk and permission to read bids.

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 BidCommercialSummary($bidId: ID!) {
  bidCommercialSummary(bidId: $bidId) {
    bidId
    costSheetId
    currency
    marginPct
    markupPct
    milestonesPctTotal
    milestones {
      amount
      dueDays
      label
      pct
      trigger
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidCommercialSummary($bidId: ID!) {\n  bidCommercialSummary(bidId: $bidId) {\n    bidId\n    costSheetId\n    currency\n    marginPct\n    markupPct\n    milestonesPctTotal\n    milestones {\n      amount\n      dueDays\n      label\n      pct\n      trigger\n    }\n  }\n}",
  "variables": {
    "bidId": "id"
  }
}
EOF

Variables:

{
  "bidId": "id"
}

Response:

{
  "data": {
    "bidCommercialSummary": {
      "bidId": "id",
      "costSheetId": "id",
      "currency": "string",
      "marginPct": "string",
      "markupPct": "string",
      "milestonesPctTotal": "string",
      "milestones": [
        {
          "amount": "string",
          "dueDays": 0,
          "label": "string",
          "pct": "string",
          "trigger": "ADVANCE"
        }
      ]
    }
  }
}

bidCommercialSummary(
  bidId: ID!
): BidCommercialSummary!

Arguments

bidCommercialSummary.bidId ● ID! non-null scalar

The bid.

Type

BidCommercialSummary object

What a bid's commercial tab shows: its pricing terms and, from the cost sheet in force (the approved one as of its approval, else the newest draft or submitted one), the price, the margin and markup it implies and each payment milestone's amount. Every figure comes from the roll-up engine; the screen computes none.