pyocf.types

OCF types

Modules

address	Type representation of an address
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).
capitalizationdefinitionrules	Type represents the rules for determining the capitalization definition for a security
contactinfo	Type representation of a primary contact person for a stakeholder (e.g. a fund).
contactinfowithoutname	Type representation of the contact info for an individual stakeholder
conversion_mechanisms	OCF conversion_mechanisms
conversion_rights	OCF conversion_rights
conversion_triggers	OCF conversion_triggers
countrycode	Type representation of an ISO 3166-1 alpha 2 country code
countrysubdivisioncode	Type representation of the second part of an ISO 3166-2 country subdivision code
currencycode	Type representation of an ISO 4217 currency code
date	Type represention of an ISO-8601 date, e.g. 2022-01-28.
email	Type representation of an email address
file	Type representation of a file
interestrate	Type representation of an interest rate, including accrual start and end dates
md5	String representation of MD5 hash with basic validation for a string of 32 characters composed of letters (uppercase or lowercase) and numbers
monetary	Type representation of an amount of money in a specified currency
name	Type comprising of multiple name components
numeric	Fixed-point string representation of a number (up to 10 decimal places supported)
objectreference	A type representing a reference to any kind of OCF object
percentage	Fixed-point string representation of a percentage as a decimal between 0.0 and 1.0 (up to 10 decimal places supported)
phone	Type representation of a phone number
ratio	Type representation of a ratio as two parts of a quotient, i.e. numerator and denominator numeric values.
securityexemption	Type representation of a securities issuance exemption that includes an unstructured description and a country code for ease of processing and analysis
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
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).
taxid	Type representation of a government identifier for tax purposes (e.g. EIN) and corresponding country code (ISO-3166).
terminationwindow	Type representation of a termination window
vesting	Describes an exact vesting date and amount