bidCostSheetView

Requires permission biddesk:cost_sheet:read.

Everything the cost sheet screen shows: the frozen tree and its names, each line's status, age and total, and the roll-up from pricing-core, priced with the bid's pricing terms. Every amount is null without permission to view costs; the price, margin and markup are also null without permission to view margins. 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 BidCostSheetView($costSheetId: ID!) {
  bidCostSheetView(costSheetId: $costSheetId) {
    costSheetId
    missingCostCount
    snapshotHash
    staleCount
    tree
    labels {
      name
      productId
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BidCostSheetView($costSheetId: ID!) {\n  bidCostSheetView(costSheetId: $costSheetId) {\n    costSheetId\n    missingCostCount\n    snapshotHash\n    staleCount\n    tree\n    labels {\n      name\n      productId\n    }\n  }\n}",
  "variables": {
    "costSheetId": "id"
  }
}
EOF

Variables:

{
  "costSheetId": "id"
}

Response:

{
  "data": {
    "bidCostSheetView": {
      "costSheetId": "id",
      "missingCostCount": 0,
      "snapshotHash": "string",
      "staleCount": 0,
      "tree": {},
      "labels": [
        {
          "name": "string",
          "productId": "id"
        }
      ]
    }
  }
}

bidCostSheetView(
  costSheetId: ID!
): BidCostSheetView!

Arguments

bidCostSheetView.costSheetId ● ID! non-null scalar

The cost sheet.

Type

BidCostSheetView object

Everything the cost sheet screen shows, in one read: the frozen tree and its names, each line's status, age and total, and the roll-up. Every amount comes from pricing-core; for a caller without permission to view costs every amount is null and the roll-up is not run.