Plan Summary Detailed Response

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/shareworks/main/json-schema/PlanSummaryDetailsWithGrants.json",
  "title": "Plan Summary Detailed Response",
  "required": [
    "approved",
    "governingLaw",
    "grants",
    "numberOfGrants",
    "planApprovalDate",
    "planId",
    "planName",
    "totalCancelledShares",
    "totalExercisedShares",
    "totalGrantedShares",
    "totalOutstandingShares",
    "totalRepurchasedShares",
    "totalReservedShares",
    "totalSharesRemainingForIssuance"
  ],
  "type": "object",
  "properties": {
    "planId": {
      "type": "integer",
      "description": "Identifier for the company plan",
      "format": "int32"
    },
    "planName": {
      "type": "string",
      "description": "Name for the company plan"
    },
    "planApprovalDate": {
      "type": "string",
      "description": "Approval date for the plan",
      "format": "date"
    },
    "totalReservedShares": {
      "type": "number",
      "description": "Total number of shares reserved for the plan",
      "format": "double"
    },
    "totalGrantedShares": {
      "type": "number",
      "description": "Total number of shares granted to stakeholders under the plan",
      "format": "double"
    },
    "totalExercisedShares": {
      "type": "number",
      "description": "Total number of granted shares exercised by the stakeholders",
      "format": "double"
    },
    "totalRepurchasedShares": {
      "type": "number",
      "description": "Total number of exercised shares repurchased back",
      "format": "double"
    },
    "totalCancelledShares": {
      "type": "number",
      "description": "Total number of shares cancelled for the plan",
      "format": "double"
    },
    "totalOutstandingShares": {
      "type": "number",
      "description": "Total number of shares outstanding for the plan",
      "format": "double"
    },
    "totalSharesRemainingForIssuance": {
      "type": "number",
      "description": "Total number of shares for the plan that are remaining to be issued to stakeholders",
      "format": "double"
    },
    "numberOfGrants": {
      "type": "integer",
      "description": "The total number of grants issued under the plan",
      "format": "int32"
    },
    "governingLaw": {
      "type": "string",
      "description": "Governing law for the plan",
      "enum": [
        "CA_AB",
        "CA_BC",
        "CA_MB",
        "CA_NB",
        "CA_NL",
        "CA_NS",
        "CA_NT",
        "CA_NU",
        "CA_ON",
        "CA_PE",
        "CA_QC",
        "CA_SK",
        "CA_YT",
        "US_AK",
        "US_AL",
        "US_AR",
        "US_AZ",
        "US_CA",
        "US_CO",
        "US_CT",
        "US_DC",
        "US_DE",
        "US_FL",
        "US_GA",
        "US_HI",
        "US_IA",
        "US_ID",
        "US_IL",
        "US_IN",
        "US_KS",
        "US_KY",
        "US_LA",
        "US_MA",
        "US_MD",
        "US_ME",
        "US_MI",
        "US_MN",
        "US_MO",
        "US_MS",
        "US_MT",
        "US_NC",
        "US_ND",
        "US_NE",
        "US_NH",
        "US_NJ",
        "US_NM",
        "US_NV",
        "US_NY",
        "US_OH",
        "US_OK",
        "US_OR",
        "US_PA",
        "US_RI",
        "US_SC",
        "US_SD",
        "US_TN",
        "US_TX",
        "US_UT",
        "US_VA",
        "US_VT",
        "US_WA",
        "US_WI",
        "US_WV",
        "US_WY",
        "US_AA",
        "US_AE",
        "US_AP",
        "AS",
        "GU",
        "MP",
        "PR",
        "VI",
        "AU_ACT",
        "AU_NSW",
        "AU_NT",
        "AU_QLD",
        "AU_SA",
        "AU_TAS",
        "AU_VIC",
        "AU_WA",
        "DE_BW",
        "DE_BY",
        "DE_BE",
        "DE_BB",
        "DE_HB",
        "DE_HH",
        "DE_HE",
        "DE_MV",
        "DE_NI",
        "DE_NW",
        "DE_RP",
        "DE_SL",
        "DE_SN",
        "DE_ST",
        "DE_SH",
        "DE_TH",
        "CH_ZH",
        "CH_BE",
        "CH_LU",
        "CH_UR",
        "CH_SZ",
        "CH_OW",
        "CH_NW",
        "CH_GL",
        "CH_ZG",
        "CH_FR",
        "CH_SO",
        "CH_BS",
        "CH_BL",
        "CH_SH",
        "CH_AR",
        "CH_AI",
        "CH_SG",
        "CH_GR",
        "CH_AG",
        "CH_TG",
        "CH_TI",
        "CH_VD",
        "CH_VS",
        "CH_NE",
        "CH_GE",
        "CH_JU",
        "IT_21",
        "IT_23",
        "IT_25",
        "IT_32",
        "IT_34",
        "IT_36",
        "IT_42",
        "IT_45",
        "IT_52",
        "IT_55",
        "IT_57",
        "IT_62",
        "IT_65",
        "IT_67",
        "IT_72",
        "IT_75",
        "IT_77",
        "IT_78",
        "IT_82",
        "IT_88"
      ]
    },
    "approved": {
      "type": "boolean",
      "description": "Approval status of the plan"
    },
    "grants": {
      "type": "array",
      "description": "List of all grants under the plan",
      "items": {
        "$ref": "#/components/schemas/StakeholderGrantSummaryDetails"
      }
    }
  }
}