diff --git a/docs/schema_markdown/schema/enums/ObjectType.md b/docs/schema_markdown/schema/enums/ObjectType.md index 21fd99feb..847cb8873 100644 --- a/docs/schema_markdown/schema/enums/ObjectType.md +++ b/docs/schema_markdown/schema/enums/ObjectType.md @@ -4,7 +4,7 @@ **Description:** _Enumeration of object types_ -**ONE OF:**
• ISSUER
• STAKEHOLDER
• STOCK_CLASS
• STOCK_LEGEND_TEMPLATE
• STOCK_PLAN
• VALUATION
• VESTING_TERMS
• TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT
• TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_SPLIT
• TX_STOCK_PLAN_POOL_ADJUSTMENT
• TX_STOCK_PLAN_RETURN_TO_POOL
• TX_CONVERTIBLE_ACCEPTANCE
• TX_CONVERTIBLE_CANCELLATION
• TX_CONVERTIBLE_CONVERSION
• TX_CONVERTIBLE_ISSUANCE
• TX_CONVERTIBLE_RETRACTION
• TX_CONVERTIBLE_TRANSFER
• TX_EQUITY_COMPENSATION_ACCEPTANCE
• TX_EQUITY_COMPENSATION_CANCELLATION
• TX_EQUITY_COMPENSATION_EXERCISE
• TX_EQUITY_COMPENSATION_ISSUANCE
• TX_EQUITY_COMPENSATION_RELEASE
• TX_EQUITY_COMPENSATION_RETRACTION
• TX_EQUITY_COMPENSATION_TRANSFER
• TX_PLAN_SECURITY_ACCEPTANCE
• TX_PLAN_SECURITY_CANCELLATION
• TX_PLAN_SECURITY_EXERCISE
• TX_PLAN_SECURITY_ISSUANCE
• TX_PLAN_SECURITY_RELEASE
• TX_PLAN_SECURITY_RETRACTION
• TX_PLAN_SECURITY_TRANSFER
• TX_STOCK_ACCEPTANCE
• TX_STOCK_CANCELLATION
• TX_STOCK_CONVERSION
• TX_STOCK_ISSUANCE
• TX_STOCK_REISSUANCE
• TX_STOCK_REPURCHASE
• TX_STOCK_RETRACTION
• TX_STOCK_TRANSFER
• TX_WARRANT_ACCEPTANCE
• TX_WARRANT_CANCELLATION
• TX_WARRANT_EXERCISE
• TX_WARRANT_ISSUANCE
• TX_WARRANT_RETRACTION
• TX_WARRANT_TRANSFER
• TX_VESTING_ACCELERATION
• TX_VESTING_START
• TX_VESTING_EVENT +**ONE OF:**
• ISSUER
• STAKEHOLDER
• STOCK_CLASS
• STOCK_LEGEND_TEMPLATE
• STOCK_PLAN
• VALUATION
• VESTING_TERMS
• TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT
• TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_SPLIT
• TX_STOCK_PLAN_POOL_ADJUSTMENT
• TX_STOCK_PLAN_RETURN_TO_POOL
• TX_CONVERTIBLE_ACCEPTANCE
• TX_CONVERTIBLE_CANCELLATION
• TX_CONVERTIBLE_CONVERSION
• TX_CONVERTIBLE_ISSUANCE
• TX_CONVERTIBLE_RETRACTION
• TX_CONVERTIBLE_TRANSFER
• TX_EQUITY_COMPENSATION_ACCEPTANCE
• TX_EQUITY_COMPENSATION_CANCELLATION
• TX_EQUITY_COMPENSATION_EXERCISE
• TX_EQUITY_COMPENSATION_ISSUANCE
• TX_EQUITY_COMPENSATION_RELEASE
• TX_EQUITY_COMPENSATION_RETRACTION
• TX_EQUITY_COMPENSATION_TRANSFER
• TX_PLAN_SECURITY_ACCEPTANCE
• TX_PLAN_SECURITY_CANCELLATION
• TX_PLAN_SECURITY_EXERCISE
• TX_PLAN_SECURITY_ISSUANCE
• TX_PLAN_SECURITY_RELEASE
• TX_PLAN_SECURITY_RETRACTION
• TX_PLAN_SECURITY_TRANSFER
• TX_STOCK_ACCEPTANCE
• TX_STOCK_CANCELLATION
• TX_STOCK_CONVERSION
• TX_STOCK_ISSUANCE
• TX_STOCK_REISSUANCE
• TX_STOCK_REPURCHASE
• TX_STOCK_RETRACTION
• TX_STOCK_TRANSFER
• TX_WARRANT_ACCEPTANCE
• TX_WARRANT_CANCELLATION
• TX_WARRANT_EXERCISE
• TX_WARRANT_ISSUANCE
• TX_WARRANT_RETRACTION
• TX_WARRANT_TRANSFER
• TX_VESTING_ACCELERATION
• TX_VESTING_START
• TX_VESTING_EVENT **Source Code:** [schema/enums/ObjectType](../../../../schema/enums/ObjectType.schema.json) diff --git a/docs/schema_markdown/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.md b/docs/schema_markdown/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.md index a895d806f..2bdba3ad7 100644 --- a/docs/schema_markdown/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.md +++ b/docs/schema_markdown/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.md @@ -2,7 +2,7 @@ `https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json` -**Description:** _Object describing an event to change the number of authoried shares of an issuer._ +**Description:** _Object describing an event to change the number of authoried shares at the issuer level._ **Data Type:** `OCF Object - TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT` @@ -20,11 +20,39 @@ | comments | [`STRING`] | Unstructured text comments related to and stored for the object | - | | object_type | **Constant:** `TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT`
_Defined in [schema/enums/ObjectType](../../../enums/ObjectType.md)_ | Object type field | `REQUIRED` | | date | [schema/types/Date](../../../types/Date.md) | Date on which the transaction occurred | `REQUIRED` | -| issuer_id | `STRING` | Identifier of the Issuer object, a subject of this transaction | - | +| issuer_id | `STRING` | Identifier of the Issuer object, a subject of this transaction | `REQUIRED` | | new_shares_authorized | [schema/types/Numeric](../../../types/Numeric.md) | The new number of shares authorized for this issuer as of the event of this transaction | `REQUIRED` | | board_approval_date | [schema/types/Date](../../../types/Date.md) | Date on which the board approved the change to the issuer | - | | stockholder_approval_date | [schema/types/Date](../../../types/Date.md) | Date on which the stockholders approved the change to the issuer | - | **Source Code:** [schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment](../../../../../../schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json) +**Examples:** + +```json +[ + { + "object_type": "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT", + "id": "test-issuer-level-share-adjustment-minimal", + "issuer_id": "ad98a30d-aeae-4282-affa-7b9fe033d5e6", + "date": "2020-03-22", + "new_shares_authorized": "10000000" + }, + { + "object_type": "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT", + "id": "test-issuer-level-share-adjustment-all-fields", + "issuer_id": "ad98a30d-aeae-4282-affa-7b9fe033d5e6", + "date": "2020-03-22", + "new_shares_authorized": "10000000", + "board_approval_date": "2020-03-31", + "stockholder_approval_date": "2020-04-01", + "comments": [ + "comment-one", + "comment-two", + "..." + ] + } +] +``` + Copyright © 2024 Open Cap Table Coalition. diff --git a/docs/schema_markdown/schema/primitives/objects/Object.md b/docs/schema_markdown/schema/primitives/objects/Object.md index 098f66cd4..be5d49739 100644 --- a/docs/schema_markdown/schema/primitives/objects/Object.md +++ b/docs/schema_markdown/schema/primitives/objects/Object.md @@ -8,11 +8,11 @@ **Properties:** -| Property | Type | Description | Required | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | ---------- | -| id | `STRING` | Identifier for the object | `REQUIRED` | -| comments | [`STRING`] | Unstructured text comments related to and stored for the object | - | -| object_type | `Enum - Object Type`

_Description:_ Enumeration of object types

**ONE OF:**
• ISSUER
• STAKEHOLDER
• STOCK_CLASS
• STOCK_LEGEND_TEMPLATE
• STOCK_PLAN
• VALUATION
• VESTING_TERMS
• TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT
• TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_SPLIT
• TX_STOCK_PLAN_POOL_ADJUSTMENT
• TX_STOCK_PLAN_RETURN_TO_POOL
• TX_CONVERTIBLE_ACCEPTANCE
• TX_CONVERTIBLE_CANCELLATION
• TX_CONVERTIBLE_CONVERSION
• TX_CONVERTIBLE_ISSUANCE
• TX_CONVERTIBLE_RETRACTION
• TX_CONVERTIBLE_TRANSFER
• TX_EQUITY_COMPENSATION_ACCEPTANCE
• TX_EQUITY_COMPENSATION_CANCELLATION
• TX_EQUITY_COMPENSATION_EXERCISE
• TX_EQUITY_COMPENSATION_ISSUANCE
• TX_EQUITY_COMPENSATION_RELEASE
• TX_EQUITY_COMPENSATION_RETRACTION
• TX_EQUITY_COMPENSATION_TRANSFER
• TX_PLAN_SECURITY_ACCEPTANCE
• TX_PLAN_SECURITY_CANCELLATION
• TX_PLAN_SECURITY_EXERCISE
• TX_PLAN_SECURITY_ISSUANCE
• TX_PLAN_SECURITY_RELEASE
• TX_PLAN_SECURITY_RETRACTION
• TX_PLAN_SECURITY_TRANSFER
• TX_STOCK_ACCEPTANCE
• TX_STOCK_CANCELLATION
• TX_STOCK_CONVERSION
• TX_STOCK_ISSUANCE
• TX_STOCK_REISSUANCE
• TX_STOCK_REPURCHASE
• TX_STOCK_RETRACTION
• TX_STOCK_TRANSFER
• TX_WARRANT_ACCEPTANCE
• TX_WARRANT_CANCELLATION
• TX_WARRANT_EXERCISE
• TX_WARRANT_ISSUANCE
• TX_WARRANT_RETRACTION
• TX_WARRANT_TRANSFER
• TX_VESTING_ACCELERATION
• TX_VESTING_START
• TX_VESTING_EVENT | Object type field | `REQUIRED` | +| Property | Type | Description | Required | +| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ---------- | +| id | `STRING` | Identifier for the object | `REQUIRED` | +| comments | [`STRING`] | Unstructured text comments related to and stored for the object | - | +| object_type | `Enum - Object Type`

_Description:_ Enumeration of object types

**ONE OF:**
• ISSUER
• STAKEHOLDER
• STOCK_CLASS
• STOCK_LEGEND_TEMPLATE
• STOCK_PLAN
• VALUATION
• VESTING_TERMS
• TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT
• TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT
• TX_STOCK_CLASS_SPLIT
• TX_STOCK_PLAN_POOL_ADJUSTMENT
• TX_STOCK_PLAN_RETURN_TO_POOL
• TX_CONVERTIBLE_ACCEPTANCE
• TX_CONVERTIBLE_CANCELLATION
• TX_CONVERTIBLE_CONVERSION
• TX_CONVERTIBLE_ISSUANCE
• TX_CONVERTIBLE_RETRACTION
• TX_CONVERTIBLE_TRANSFER
• TX_EQUITY_COMPENSATION_ACCEPTANCE
• TX_EQUITY_COMPENSATION_CANCELLATION
• TX_EQUITY_COMPENSATION_EXERCISE
• TX_EQUITY_COMPENSATION_ISSUANCE
• TX_EQUITY_COMPENSATION_RELEASE
• TX_EQUITY_COMPENSATION_RETRACTION
• TX_EQUITY_COMPENSATION_TRANSFER
• TX_PLAN_SECURITY_ACCEPTANCE
• TX_PLAN_SECURITY_CANCELLATION
• TX_PLAN_SECURITY_EXERCISE
• TX_PLAN_SECURITY_ISSUANCE
• TX_PLAN_SECURITY_RELEASE
• TX_PLAN_SECURITY_RETRACTION
• TX_PLAN_SECURITY_TRANSFER
• TX_STOCK_ACCEPTANCE
• TX_STOCK_CANCELLATION
• TX_STOCK_CONVERSION
• TX_STOCK_ISSUANCE
• TX_STOCK_REISSUANCE
• TX_STOCK_REPURCHASE
• TX_STOCK_RETRACTION
• TX_STOCK_TRANSFER
• TX_WARRANT_ACCEPTANCE
• TX_WARRANT_CANCELLATION
• TX_WARRANT_EXERCISE
• TX_WARRANT_ISSUANCE
• TX_WARRANT_RETRACTION
• TX_WARRANT_TRANSFER
• TX_VESTING_ACCELERATION
• TX_VESTING_START
• TX_VESTING_EVENT | Object type field | `REQUIRED` | **Source Code:** [schema/primitives/objects/Object](../../../../../schema/primitives/objects/Object.schema.json) diff --git a/docs/schema_markdown/schema/primitives/objects/transactions/IssuerTransaction.md b/docs/schema_markdown/schema/primitives/objects/transactions/IssuerTransaction.md index 641a90549..70f7bbaa8 100644 --- a/docs/schema_markdown/schema/primitives/objects/transactions/IssuerTransaction.md +++ b/docs/schema_markdown/schema/primitives/objects/transactions/IssuerTransaction.md @@ -8,9 +8,9 @@ **Properties:** -| Property | Type | Description | Required | -| --------- | -------- | -------------------------------------------------------------- | -------- | -| issuer_id | `STRING` | Identifier of the Issuer object, a subject of this transaction | - | +| Property | Type | Description | Required | +| --------- | -------- | -------------------------------------------------------------- | ---------- | +| issuer_id | `STRING` | Identifier of the Issuer object, a subject of this transaction | `REQUIRED` | **Source Code:** [schema/primitives/objects/transactions/IssuerTransaction](../../../../../../schema/primitives/objects/transactions/IssuerTransaction.schema.json) diff --git a/samples/Transactions.ocf.json b/samples/Transactions.ocf.json index 7a6d85954..930f1cdd6 100644 --- a/samples/Transactions.ocf.json +++ b/samples/Transactions.ocf.json @@ -1,6 +1,23 @@ { "file_type": "OCF_TRANSACTIONS_FILE", "items": [ + { + "object_type": "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT", + "id": "test-issuer-level-share-adjustment-minimal", + "issuer_id": "ad98a30d-aeae-4282-affa-7b9fe033d5e6", + "date": "2020-03-22", + "new_shares_authorized": "10000000" + }, + { + "object_type": "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT", + "id": "test-issuer-level-share-adjustment-all-fields", + "issuer_id": "ad98a30d-aeae-4282-affa-7b9fe033d5e6", + "date": "2020-03-22", + "new_shares_authorized": "10000000", + "board_approval_date": "2020-03-31", + "stockholder_approval_date": "2020-04-01", + "comments": ["comment-one", "comment-two", "..."] + }, { "object_type": "TX_CONVERTIBLE_ACCEPTANCE", "id": "test-convertible-acceptance-minimal", diff --git a/schema/enums/ObjectType.schema.json b/schema/enums/ObjectType.schema.json index 2c0a96812..986b6ed76 100644 --- a/schema/enums/ObjectType.schema.json +++ b/schema/enums/ObjectType.schema.json @@ -12,6 +12,7 @@ "STOCK_PLAN", "VALUATION", "VESTING_TERMS", + "TX_ISSUER_AUTHORIZED_SHARES_ADJUSTMENT", "TX_STOCK_CLASS_CONVERSION_RATIO_ADJUSTMENT", "TX_STOCK_CLASS_AUTHORIZED_SHARES_ADJUSTMENT", "TX_STOCK_CLASS_SPLIT", diff --git a/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json b/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json index f40f6ee3f..27a455a37 100644 --- a/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json +++ b/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json @@ -2,7 +2,7 @@ "$schema": "http://json-schema.org/draft-07/schema", "$id": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/adjustment/IssuerAuthorizedSharesAdjustment.schema.json", "title": "Object - Issuer Authorized Shares Adjustment Transaction", - "description": "Object describing an event to change the number of authoried shares of an issuer.", + "description": "Object describing an event to change the number of authoried shares at the issuer level.", "type": "object", "allOf": [ { diff --git a/schema/primitives/objects/transactions/IssuerTransaction.schema.json b/schema/primitives/objects/transactions/IssuerTransaction.schema.json index 1e2066097..f9e439030 100644 --- a/schema/primitives/objects/transactions/IssuerTransaction.schema.json +++ b/schema/primitives/objects/transactions/IssuerTransaction.schema.json @@ -10,6 +10,6 @@ "type": "string" } }, - "required": ["stock_class_id"], + "required": ["issuer_id"], "$comment": "Copyright © 2024 Open Cap Table Coalition (https://opencaptablecoalition.com) / Original File: https://github.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/tree/main/schema/primitives/objects/transactions/IssuerTransaction.schema.json" }