Skip to main content

BidCommercialSummary

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.

type BidCommercialSummary {
  bidId: ID!
  costSheetId: ID
  currency: String
  marginPct: String
  markupPct: String
  milestones: [BidCommercialMilestone!]!
  milestonesPctTotal: String
  price: String
  sheetStatus: BidCostSheetStatus
  sheetVersion: Int
  terms: BidPricingTerms
  totalCost: String
  unitPrice: String
}

Fields​

BidCommercialSummary.bidId ● ID! non-null scalar​

The bid.

BidCommercialSummary.costSheetId ● ID scalar​

The cost sheet in force; null when the bid has none.

BidCommercialSummary.currency ● String scalar​

That sheet's currency (ISO 4217), which every figure is in.

BidCommercialSummary.marginPct ● String scalar​

The margin the price implies, as a percentage of the price (4 dp). Null without permission to view margins, or to view costs (the roll-up is not run), and when there is no cost sheet or no pricing terms.

BidCommercialSummary.markupPct ● String scalar​

The markup the price implies, as a percentage of the cost (4 dp). Null without permission to view margins, or to view costs (the roll-up is not run), and when there is no cost sheet or no pricing terms.

BidCommercialSummary.milestones ● [BidCommercialMilestone!]! non-null object​

The payment schedule's milestones in order; empty before one is set.

BidCommercialSummary.milestonesPctTotal ● String scalar​

The sum of the milestone shares (100.00 for a valid schedule); null without a schedule.

BidCommercialSummary.price ● String scalar​

The price the terms give. Null without permission to view margins, or to view costs (the roll-up is not run), and when there is no cost sheet or no pricing terms.

BidCommercialSummary.sheetStatus ● BidCostSheetStatus enum​

That sheet's status.

BidCommercialSummary.sheetVersion ● Int scalar​

That sheet's number within the bid.

BidCommercialSummary.terms ● BidPricingTerms object​

The bid's pricing terms; null before they are set.

BidCommercialSummary.totalCost ● String scalar​

The sheet's total cost. Null without permission to view costs, or when there is no cost sheet.

BidCommercialSummary.unitPrice ● String scalar​

The price divided by the configured quantity. Null without permission to view margins, or to view costs (the roll-up is not run), and when there is no cost sheet or no pricing terms.

Returned By​

bidCommercialSummary query