People pillar · v0.16.0

benefit-plan BenefitPlan

Benefit-plan record (entity-wide rule).

$id · https://corpospec.com/schemas/v0.16.0/benefit-plan.schema.json

Fields

Field Type Required Description
carrier string yes Plan administrator / insurance carrier.
category BenefitCategory yes Benefit category.
effective_from IsoDate yes ISO 8601 date (YYYY-MM-DD).
entity PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
funding FundingModel yes Plan funding model.
id PathRef yes Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
jurisdiction IsoCountry yes ISO 3166-1 alpha-2 country code.
name string yes
period_currency IsoCurrency yes ISO 4217 currency code.
statutory_basis string yes Statutory basis (e.g. "BetrAVG § 1a", "Pensions Act 2008", "IRC § 401(k)", "EStG § 3 Nr. 15").
waiting_period_months integer yes
bav_channel BavChannel? DE BAV channel (only meaningful when category == Pension and jurisdiction == DE).
bdr_reference PathRef?
effective_to IsoDate?
employer_cap_per_period number? Optional employer contribution cap per period.
employer_share_pct number? Employer share pct (only meaningful when funding == Shared).
plan_document PathRef?

Definitions

Shared types referenced within this schema.

BavChannel
DE BAV channel (§1b BetrAVG).
enum: "direktversicherung", "pensionskasse", "pensionsfonds", "unterstuetzungskasse", "direktzusage"
BenefitCategory
Benefit category.
FundingModel
Plan funding model.
IsoCountry
ISO 3166-1 alpha-2 country code.
pattern: ^[A-Z]{2}$
IsoCurrency
ISO 4217 currency code.
pattern: ^[A-Z]{3}$
IsoDate
ISO 8601 date (YYYY-MM-DD).
type: string
PathRef
Path-based cross-reference relative to .corpospec/ root. Pattern: `^[a-z0-9_-]+(/[a-z0-9_.-]+)+$`
pattern: ^[a-z0-9_-]+(/[a-z0-9_.-]+)+$

Reference in your YAML

# yaml-language-server: $schema=https://corpospec.com/schemas/v0.16.0/benefit-plan.schema.json