pyocf.types

OCF types

Modules

pyocf.types.address

Type representation of an address

pyocf.types.capitalizationdefinition

Type represents a group of securities that constitutes some formally defined part of the company (e.g. post-money capitalization vs pre-money for a security).

pyocf.types.contactinfo

Type representation of a primary contact person for a stakeholder (e.g. a fund).

pyocf.types.conversion_mechanisms

OCF conversion_mechanisms

pyocf.types.conversion_rights

OCF conversion_rights

pyocf.types.conversion_triggers

OCF conversion_triggers

pyocf.types.countrycode

Type representation of an ISO 3166-1 alpha 2 country code

pyocf.types.countrysubdivisioncode

Type representation of the second part of an ISO 3166-2 country subdivision code

pyocf.types.currencycode

Type representation of an ISO 4217 currency code

pyocf.types.date

Type represention of an ISO-8601 date, e.g. 2022-01-28.

pyocf.types.email

Type representation of an email address

pyocf.types.file

Type representation of a file

pyocf.types.interestrate

Type representation of an interest rate, including accrual start and end dates

pyocf.types.md5

String representation of MD5 hash with basic validation for a string of 32 characters composed of letters (uppercase or lowercase) and numbers

pyocf.types.monetary

Type representation of an amount of money in a specified currency

pyocf.types.name

Type comprising of multiple name components

pyocf.types.numeric

Fixed-point string representation of a number (up to 10 decimal places supported)

pyocf.types.percentage

Fixed-point string representation of a percentage as a decimal between 0.0 and 1.0 (up to 10 decimal places supported)

pyocf.types.phone

Type representation of a phone number

pyocf.types.ratio

Type representation of a ratio as two parts of a quotient, i.e. numerator and denominator numeric values.

pyocf.types.securityexemption

Type representation of a securities issuance exemption that includes an unstructured description and a country code for ease of processing and analysis

pyocf.types.sharenumberrange

Type representation of a range of share numbers associated with an event (such as the share numbers associated with an issuance) - for use where shares are not fungible and need unique identifiers per share

pyocf.types.stockparent

Type representation of the parent security of a given stock issuance (e.g. if a stock issuance came from a plan, such as an RSA, or if a stock came from a previous stock entry).

pyocf.types.taxid

Type representation of a government identifier for tax purposes (e.g. EIN) and corresponding country code (ISO-3166).

pyocf.types.terminationwindow

Type representation of a termination window

pyocf.types.vesting

OCF vesting