estimateSection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/acculynx/json-schema/acculynx-estimate-section-schema.json",
  "title": "estimateSection",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/acculynx-estimates-api-openapi.yml#/components/schemas/estimateSection",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "description": "The unique ID for the estimate section."
    },
    "title": {
      "type": "string",
      "description": "The title of the estimate section."
    },
    "description": {
      "type": "string",
      "description": "A description of the estimate section."
    },
    "createdBy": {
      "$ref": "#/$defs/companyUserLink"
    },
    "createdDate": {
      "type": "string",
      "description": "The date/time the estimate section was created, in UTC format."
    },
    "modifiedBy": {
      "$ref": "#/$defs/companyUserLink"
    },
    "modifiedDate": {
      "type": "string",
      "description": "The date/time the estimate section was modified, in UTC format."
    },
    "profitMarginRate": {
      "type": "number",
      "description": "The rate of profit on the estimate section."
    },
    "profitMarginTotal": {
      "type": "number",
      "description": "The total profit for the estimate section."
    },
    "sectionFinancials": {
      "$ref": "#/$defs/estimateFinancials"
    },
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/estimateItemLink"
      }
    },
    "_link": {
      "type": "string",
      "description": "The unique URI of the Estimate Section."
    }
  },
  "$defs": {
    "companyUserLink": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique GUID of the AccuLynx User.",
          "format": "uuid"
        },
        "_link": {
          "type": "string",
          "description": "The unique URI of the AccuLynx User."
        }
      },
      "description": ""
    },
    "estimateFinancials": {
      "type": "object",
      "properties": {
        "taxRate": {
          "type": "number",
          "description": "The rate of tax for the estimate."
        },
        "taxTotal": {
          "type": "number",
          "description": "The total tax for the estimate."
        },
        "overheadRate": {
          "type": "number",
          "description": "The rate of overhead for the estimate."
        },
        "overheadTotal": {
          "type": "number",
          "description": "The total overhead for the estimate."
        },
        "profitRate": {
          "type": "number",
          "description": "The rate of profit for the estimate."
        },
        "profitTotal": {
          "type": "number",
          "description": "The total profit for the estimate."
        },
        "totalCost": {
          "type": "number",
          "description": "The total cost for the estimate."
        },
        "totalPrice": {
          "type": "number",
          "description": "The total price for the estimate."
        }
      }
    },
    "estimateItemLink": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "description": "The unique identifier of the estimate item."
        },
        "_link": {
          "type": "string",
          "description": "The unique URI of the Estimate Item."
        }
      }
    }
  }
}