pyocf.files.ocfmanifestfile

Top-level schema describing the OCF Manifest, which holds issuer information and references ocf files containing transactions, stakeholders, stock classes, etc.

pydantic model pyocf.files.ocfmanifestfile.OCFManifestFile

Top-level schema describing the OCF Manifest, which holds issuer information and references ocf files containing transactions, stakeholders, stock classes, etc.

field as_of: Date [Required]

The point-in-time represented by this OCF Package

field comments: list[str] | None = None

field file_type: Literal['OCF_MANIFEST_FILE'] = 'OCF_MANIFEST_FILE'

field generated_at: str [Required]

Timestamp of when the package was generated. Useful when determining which setof data is most up-to-date, if presented with two packages that have the same`as_of` date, but different cap table data.

field issuer: Issuer [Required]

Issuer for the cap table

field ocf_version: OCFVersionType [Required]

OCF Version Identifier

field stakeholders_files: list[File] [Required]

List of files containing lists of issuer stakeholders, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stakeholders_file schema to validate loaded files)

field stock_classes_files: list[File] [Required]

List of files containing lists of issuer stock classes, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_classes_file schema to validate loaded files)

field stock_legend_templates_files: list[File] [Required]

List of files containing lists of issuer stock legend templates, indexed fromthe file containing the first such object created to the file containing thelast (See separate /schema/files/stock_legend_templates_file schema to validateloaded files)

field stock_plans_files: list[File] [Required]

List of files containing lists of issuer stock plans, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/stock_plans_file schema to validate loaded files)

field transactions_files: list[File] [Required]

List of files containing lists of issuer transactions, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/transactions_file schema to validate loaded files)

field valuations_files: list[File] [Required]

List of files containing lists of issuer valuations, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/valuations_file schema to validate loaded files)

field vesting_terms_files: list[File] [Required]

List of files containing lists of issuer vesting terms, indexed from the filecontaining the first such object created to the file containing the last (Seeseparate /schema/files/vesting_terms_file schema to validate loaded files)