API Docs / Schemas / ProposalCostGroup

ProposalCostGroup

A billing-frequency section of the proposal costs table (one heading + table per group).

Properties

Name Type Description
frequencystring

Display label: "Monthly", "Quarterly", "Annual" or "One-off".

Display label: "Monthly", "Quarterly", "Annual" or "One-off".

rowsarray of ProposalCostRow

Rows in render order: package rows, then standalone services, then setup fees.

Rows in render order: package rows, then standalone services, then setup fees.

subtotalnumber

Sum of row amounts excluding VAT. Open-ended per-unit rows contribute 0.

Sum of row amounts excluding VAT. Open-ended per-unit rows contribute 0.

totalVatnumber

Sum of row VAT amounts.

Sum of row VAT amounts.

grandTotalnumber

Subtotal + TotalVat.

Subtotal + TotalVat.

showTotalsboolean

True when the totals row should render: practice is VAT registered and the group has
more than one row.

True when the totals row should render: practice is VAT registered and the group has
more than one row.

JSON Example

{
  "frequency": "string",
  "rows": [
    {
      "name": "...",
      "pricingTierName": "...",
      "amount": "...",
      "showPriceAsNa": "...",
      "isOpenEnded": "..."
    }
  ],
  "subtotal": 0,
  "totalVat": 0,
  "grandTotal": 0
}

Contained in Schemas