{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/orion-advisor-solutions/json-schema/orion-advisor-solutions-oas-web-api-dto-billing-bill-household-summary-dto-schema.json",
  "title": "OAS.WebApi.DTO.Billing.BillHouseholdSummaryDto",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/orion-advisor-solutions-billing-householdsummary-api-openapi.yml#/components/schemas/OAS.WebApi.DTO.Billing.BillHouseholdSummaryDto",
  "properties": {
    "value": {
      "$ref": "#/$defs/OAS.WebApi.DTO.Billing.HouseholdSummaryValueDto"
    },
    "billSchedules": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.BillScheduleSummaryDto"
      },
      "type": "array"
    },
    "payoutSchedules": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.BillPayoutScheduleSummaryDto"
      },
      "type": "array"
    },
    "billFrequencies": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.BillFrequencySummaryDto"
      },
      "type": "array"
    },
    "billPayMethods": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.BillPayMethodSummaryDto"
      },
      "type": "array"
    },
    "accountSummaries": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.HouseholdAccountSummaryDto"
      },
      "type": "array"
    },
    "billPaidForAccounts": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.PaidByAccountSummaryDto"
      },
      "type": "array"
    },
    "historicalBills": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.BillHistoryDto"
      },
      "type": "array"
    },
    "relatedHouseholdSummaries": {
      "items": {
        "$ref": "#/$defs/OAS.WebApi.DTO.Billing.RelatedClientSummaryDto"
      },
      "type": "array"
    }
  },
  "type": "object",
  "$defs": {
    "OAS.WebApi.DTO.Billing.BillFrequencySummaryDto": {
      "properties": {
        "frequency": {
          "type": "integer",
          "format": "int32"
        },
        "clientId": {
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.BillHistoryDto": {
      "properties": {
        "billId": {
          "type": "integer",
          "format": "int32"
        },
        "householdId": {
          "type": "integer",
          "format": "int32"
        },
        "billInstanceId": {
          "type": "integer",
          "format": "int32"
        },
        "marketValueAtGeneration": {
          "type": "number",
          "format": "double"
        },
        "asOfDate": {
          "type": "string",
          "format": "date-time"
        },
        "billAmount": {
          "type": "number",
          "format": "double"
        },
        "balanceDue": {
          "type": "number",
          "format": "double"
        },
        "creditsToBill": {
          "type": "number",
          "format": "double"
        },
        "billPeriod": {
          "readOnly": true,
          "type": "string"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.BillPayMethodSummaryDto": {
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "payInstruction": {
          "type": "string"
        },
        "clientId": {
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.BillPayoutScheduleSummaryDto": {
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "payoutSchedule": {
          "type": "string"
        },
        "clientId": {
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.BillScheduleSummaryDto": {
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "feeSchedule": {
          "type": "string"
        },
        "clientId": {
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.HouseholdAccountSummaryDto": {
      "properties": {
        "accountId": {
          "type": "integer",
          "format": "int32"
        },
        "accountNumber": {
          "type": "string"
        },
        "accountType": {
          "type": "string"
        },
        "billingStartDate": {
          "type": "string",
          "format": "date-time"
        },
        "feeSchedule": {
          "type": "string"
        },
        "payoutSchedule": {
          "type": "string"
        },
        "payMethod": {
          "type": "string"
        },
        "frequency": {
          "type": "string",
          "enum": [
            "Undefined",
            "Monthly",
            "Quarterly",
            "Triannual",
            "Semiannually",
            "Annually",
            "AtMaturity"
          ]
        },
        "balanceDue": {
          "type": "number",
          "format": "double"
        },
        "creditRemaining": {
          "type": "number",
          "format": "double"
        },
        "repId": {
          "type": "integer",
          "format": "int32"
        },
        "repName": {
          "type": "string"
        },
        "paidByAccount": {
          "readOnly": true,
          "type": "string"
        },
        "percentPaidByAccount": {
          "readOnly": true,
          "type": "string"
        },
        "valuationMethod": {
          "type": "string",
          "enum": [
            "PeriodEndingValue",
            "AvgDailyBalance",
            "AvgMonthlyBalance"
          ]
        },
        "isActive": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.HouseholdSummaryValueDto": {
      "properties": {
        "value": {
          "type": "number",
          "format": "double"
        },
        "excludedAssetValue": {
          "type": "number",
          "format": "double"
        },
        "billableValue": {
          "readOnly": true,
          "type": "number",
          "format": "double"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.PaidByAccountSummaryDto": {
      "properties": {
        "accountId": {
          "type": "integer",
          "format": "int32"
        },
        "paidByAccountId": {
          "type": "integer",
          "format": "int32"
        },
        "percent": {
          "type": "number",
          "format": "double"
        },
        "fundName": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "OAS.WebApi.DTO.Billing.RelatedClientSummaryDto": {
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "clientName": {
          "type": "string"
        },
        "currentValue": {
          "type": "number",
          "format": "double"
        },
        "excludedValue": {
          "type": "number",
          "format": "double"
        },
        "billableValue": {
          "readOnly": true,
          "type": "number",
          "format": "double"
        }
      },
      "type": "object"
    }
  }
}