From 86195fafa5a0df5361c01abee061e6c33e69f3db Mon Sep 17 00:00:00 2001 From: Arthur Guest Date: Tue, 26 Mar 2024 18:15:34 +0530 Subject: [PATCH 1/3] Creation of consolidation transaction for stock --- samples/Transactions.ocf.json | 8 +++++ schema/enums/ObjectType.schema.json | 1 + schema/files/TransactionsFile.schema.json | 3 ++ .../StockConsolidation.schema.json | 32 +++++++++++++++++++ .../consolidation/Consolidation.schema.json | 29 +++++++++++++++++ 5 files changed, 73 insertions(+) create mode 100644 schema/objects/transactions/consolidation/StockConsolidation.schema.json create mode 100644 schema/primitives/objects/transactions/consolidation/Consolidation.schema.json diff --git a/samples/Transactions.ocf.json b/samples/Transactions.ocf.json index 7a6d85954..b5dea7003 100644 --- a/samples/Transactions.ocf.json +++ b/samples/Transactions.ocf.json @@ -1285,6 +1285,14 @@ "board_approval_date": "2022-11-14", "stockholder_approval_date": "2022-11-14", "shares_reserved": "100000000" + }, + { + "object_type": "TX_STOCK_CONSOLIDATION", + "id": "test-stock-consolidation-full-fields", + "security_ids": ["incoming-security-id-1", "incoming-security-id-2"], + "date": "2022-02-01", + "resulting_security_ids": "resultant-security-id-1", + "comments": ["Here is a comment", "Here is another comment"] } ] } diff --git a/schema/enums/ObjectType.schema.json b/schema/enums/ObjectType.schema.json index 2c0a96812..870cae1d5 100644 --- a/schema/enums/ObjectType.schema.json +++ b/schema/enums/ObjectType.schema.json @@ -42,6 +42,7 @@ "TX_STOCK_CONVERSION", "TX_STOCK_ISSUANCE", "TX_STOCK_REISSUANCE", + "TX_STOCK_CONSOLIDATION", "TX_STOCK_REPURCHASE", "TX_STOCK_RETRACTION", "TX_STOCK_TRANSFER", diff --git a/schema/files/TransactionsFile.schema.json b/schema/files/TransactionsFile.schema.json index 8552d20c8..b772a8e9d 100644 --- a/schema/files/TransactionsFile.schema.json +++ b/schema/files/TransactionsFile.schema.json @@ -66,6 +66,9 @@ { "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/reissuance/StockReissuance.schema.json" }, + { + "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/consolidation/StockConsolidation.schema.json" + }, { "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/repurchase/StockRepurchase.schema.json" }, diff --git a/schema/objects/transactions/consolidation/StockConsolidation.schema.json b/schema/objects/transactions/consolidation/StockConsolidation.schema.json new file mode 100644 index 000000000..090651154 --- /dev/null +++ b/schema/objects/transactions/consolidation/StockConsolidation.schema.json @@ -0,0 +1,32 @@ +{ + "$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/consolidation/StockConsolidation.schema.json", + "title": "Object - Stock Consolidation Transaction", + "description": "Object describing a the consolidation of multiple stock positions into one", + "type": "object", + "allOf": [ + { + "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/Object.schema.json" + }, + { + "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/Transaction.schema.json" + }, + { + "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/consolidation/consolidation.schema.json" + } + ], + "properties": { + "object_type": { + "const": "TX_STOCK_CONSOLIDATION" + }, + "id": {}, + "comments": {}, + "security_ids": {}, + "date": {}, + "resulting_security_id": {}, + "reason_text": {} + }, + "additionalProperties": false, + "required": [], + "$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/objects/transactions/consolidation/StockConsolidation.schema.json" +} diff --git a/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json b/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json new file mode 100644 index 000000000..5957c2751 --- /dev/null +++ b/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json @@ -0,0 +1,29 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json", + "title": "Primitive - Security Consolidation Transaction", + "description": "Abstract object describing common properties to a consolidation of a security", + "type": "object", + "properties": { + "security_ids": { + "title": "Security Consolidation - Incoming Securities ID Array", + "description": "Identifier for the securities (stock, plan security, warrant, or convertible) that are being consolidated into one position by which it can be referenced by other transaction objects. Note that while this identifier is created with an issuance object, it should be different than the issuance object's `id` field which identifies the issuance transaction object itself. All future transactions on the security (e.g. acceptance, transfer, cancel, etc.) must reference this `security_id` to qualify which security the transaction applies to.", + "type": "array", + "items": { + "type": "string" + } + }, + "resulting_security_id": { + "title": "Security Consolidation - Resulting Security ID", + "description": "Identifier of the new security issuance resulting from a consolidation", + "type": "string" + }, + "reason_text": { + "title": "Reason for stock consolidation", + "description": "Free-form human-readable reason for stock consolidation", + "type": "string" + } + }, + "required": ["resulting_security_id", "security_ids"], + "$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/consolidation/Consolidation.schema.json" +} From f460d1a2b04ebf48bd6e98ffaeebafba31be9930 Mon Sep 17 00:00:00 2001 From: Arthur Guest Date: Tue, 26 Mar 2024 18:29:11 +0530 Subject: [PATCH 2/3] Typo fix --- .../schema/enums/ObjectType.md | 2 +- .../schema/files/TransactionsFile.md | 8 +-- .../consolidation/StockConsolidation.md | 54 +++++++++++++++++++ .../schema/primitives/objects/Object.md | 10 ++-- .../consolidation/Consolidation.md | 23 ++++++++ .../StockConsolidation.schema.json | 2 +- 6 files changed, 88 insertions(+), 11 deletions(-) create mode 100644 docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md create mode 100644 docs/schema_markdown/schema/primitives/objects/transactions/consolidation/Consolidation.md diff --git a/docs/schema_markdown/schema/enums/ObjectType.md b/docs/schema_markdown/schema/enums/ObjectType.md index da5d6b17b..01245111a 100644 --- a/docs/schema_markdown/schema/enums/ObjectType.md +++ b/docs/schema_markdown/schema/enums/ObjectType.md @@ -8,7 +8,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_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_CONSOLIDATION
• 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/files/TransactionsFile.md b/docs/schema_markdown/schema/files/TransactionsFile.md index cbf18f8ed..89256569d 100644 --- a/docs/schema_markdown/schema/files/TransactionsFile.md +++ b/docs/schema_markdown/schema/files/TransactionsFile.md @@ -16,10 +16,10 @@ **Properties:** -| Property | Type | Description | Required | -| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------- | ---------- | -| file_type | **Constant:** `OCF_TRANSACTIONS_FILE`
_Defined in [schema/enums/FileType](../enums/FileType.md)_ | Object type field | `REQUIRED` | -| items | **Array of ONE OF the Following Types/Objs:**
• [schema/objects/transactions/acceptance/ConvertibleAcceptance](../objects/transactions/acceptance/ConvertibleAcceptance.md)
•[schema/objects/transactions/acceptance/EquityCompensationAcceptance](../objects/transactions/acceptance/EquityCompensationAcceptance.md)
•[schema/objects/transactions/acceptance/StockAcceptance](../objects/transactions/acceptance/StockAcceptance.md)
•[schema/objects/transactions/acceptance/WarrantAcceptance](../objects/transactions/acceptance/WarrantAcceptance.md)
•[schema/objects/transactions/cancellation/ConvertibleCancellation](../objects/transactions/cancellation/ConvertibleCancellation.md)
•[schema/objects/transactions/cancellation/EquityCompensationCancellation](../objects/transactions/cancellation/EquityCompensationCancellation.md)
•[schema/objects/transactions/cancellation/StockCancellation](../objects/transactions/cancellation/StockCancellation.md)
•[schema/objects/transactions/cancellation/WarrantCancellation](../objects/transactions/cancellation/WarrantCancellation.md)
•[schema/objects/transactions/conversion/ConvertibleConversion](../objects/transactions/conversion/ConvertibleConversion.md)
•[schema/objects/transactions/conversion/StockConversion](../objects/transactions/conversion/StockConversion.md)
•[schema/objects/transactions/exercise/EquityCompensationExercise](../objects/transactions/exercise/EquityCompensationExercise.md)
•[schema/objects/transactions/exercise/WarrantExercise](../objects/transactions/exercise/WarrantExercise.md)
•[schema/objects/transactions/issuance/ConvertibleIssuance](../objects/transactions/issuance/ConvertibleIssuance.md)
•[schema/objects/transactions/issuance/EquityCompensationIssuance](../objects/transactions/issuance/EquityCompensationIssuance.md)
•[schema/objects/transactions/issuance/StockIssuance](../objects/transactions/issuance/StockIssuance.md)
•[schema/objects/transactions/issuance/WarrantIssuance](../objects/transactions/issuance/WarrantIssuance.md)
•[schema/objects/transactions/reissuance/StockReissuance](../objects/transactions/reissuance/StockReissuance.md)
•[schema/objects/transactions/repurchase/StockRepurchase](../objects/transactions/repurchase/StockRepurchase.md)
•[schema/objects/transactions/release/EquityCompensationRelease](../objects/transactions/release/EquityCompensationRelease.md)
•[schema/objects/transactions/retraction/ConvertibleRetraction](../objects/transactions/retraction/ConvertibleRetraction.md)
•[schema/objects/transactions/retraction/EquityCompensationRetraction](../objects/transactions/retraction/EquityCompensationRetraction.md)
•[schema/objects/transactions/retraction/StockRetraction](../objects/transactions/retraction/StockRetraction.md)
•[schema/objects/transactions/retraction/WarrantRetraction](../objects/transactions/retraction/WarrantRetraction.md)
•[schema/objects/transactions/return_to_pool/StockPlanReturnToPool](../objects/transactions/return_to_pool/StockPlanReturnToPool.md)
•[schema/objects/transactions/split/StockClassSplit](../objects/transactions/split/StockClassSplit.md)
•[schema/objects/transactions/adjustment/StockClassConversionRatioAdjustment](../objects/transactions/adjustment/StockClassConversionRatioAdjustment.md)
•[schema/objects/transactions/adjustment/StockClassAuthorizedSharesAdjustment](../objects/transactions/adjustment/StockClassAuthorizedSharesAdjustment.md)
•[schema/objects/transactions/transfer/ConvertibleTransfer](../objects/transactions/transfer/ConvertibleTransfer.md)
•[schema/objects/transactions/transfer/EquityCompensationTransfer](../objects/transactions/transfer/EquityCompensationTransfer.md)
•[schema/objects/transactions/transfer/StockTransfer](../objects/transactions/transfer/StockTransfer.md)
•[schema/objects/transactions/transfer/WarrantTransfer](../objects/transactions/transfer/WarrantTransfer.md)
•[schema/objects/transactions/vesting/VestingAcceleration](../objects/transactions/vesting/VestingAcceleration.md)
•[schema/objects/transactions/vesting/VestingStart](../objects/transactions/vesting/VestingStart.md)
•[schema/objects/transactions/vesting/VestingEvent](../objects/transactions/vesting/VestingEvent.md)
•[schema/objects/transactions/adjustment/StockPlanPoolAdjustment](../objects/transactions/adjustment/StockPlanPoolAdjustment.md) | List of OCF transaction objects | `REQUIRED` | +| Property | Type | Description | Required | +| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | ---------- | +| file_type | **Constant:** `OCF_TRANSACTIONS_FILE`
_Defined in [schema/enums/FileType](../enums/FileType.md)_ | Object type field | `REQUIRED` | +| items | **Array of ONE OF the Following Types/Objs:**
• [schema/objects/transactions/acceptance/ConvertibleAcceptance](../objects/transactions/acceptance/ConvertibleAcceptance.md)
•[schema/objects/transactions/acceptance/EquityCompensationAcceptance](../objects/transactions/acceptance/EquityCompensationAcceptance.md)
•[schema/objects/transactions/acceptance/StockAcceptance](../objects/transactions/acceptance/StockAcceptance.md)
•[schema/objects/transactions/acceptance/WarrantAcceptance](../objects/transactions/acceptance/WarrantAcceptance.md)
•[schema/objects/transactions/cancellation/ConvertibleCancellation](../objects/transactions/cancellation/ConvertibleCancellation.md)
•[schema/objects/transactions/cancellation/EquityCompensationCancellation](../objects/transactions/cancellation/EquityCompensationCancellation.md)
•[schema/objects/transactions/cancellation/StockCancellation](../objects/transactions/cancellation/StockCancellation.md)
•[schema/objects/transactions/cancellation/WarrantCancellation](../objects/transactions/cancellation/WarrantCancellation.md)
•[schema/objects/transactions/conversion/ConvertibleConversion](../objects/transactions/conversion/ConvertibleConversion.md)
•[schema/objects/transactions/conversion/StockConversion](../objects/transactions/conversion/StockConversion.md)
•[schema/objects/transactions/exercise/EquityCompensationExercise](../objects/transactions/exercise/EquityCompensationExercise.md)
•[schema/objects/transactions/exercise/WarrantExercise](../objects/transactions/exercise/WarrantExercise.md)
•[schema/objects/transactions/issuance/ConvertibleIssuance](../objects/transactions/issuance/ConvertibleIssuance.md)
•[schema/objects/transactions/issuance/EquityCompensationIssuance](../objects/transactions/issuance/EquityCompensationIssuance.md)
•[schema/objects/transactions/issuance/StockIssuance](../objects/transactions/issuance/StockIssuance.md)
•[schema/objects/transactions/issuance/WarrantIssuance](../objects/transactions/issuance/WarrantIssuance.md)
•[schema/objects/transactions/reissuance/StockReissuance](../objects/transactions/reissuance/StockReissuance.md)
•[schema/objects/transactions/consolidation/StockConsolidation](../objects/transactions/consolidation/StockConsolidation.md)
•[schema/objects/transactions/repurchase/StockRepurchase](../objects/transactions/repurchase/StockRepurchase.md)
•[schema/objects/transactions/release/EquityCompensationRelease](../objects/transactions/release/EquityCompensationRelease.md)
•[schema/objects/transactions/retraction/ConvertibleRetraction](../objects/transactions/retraction/ConvertibleRetraction.md)
•[schema/objects/transactions/retraction/EquityCompensationRetraction](../objects/transactions/retraction/EquityCompensationRetraction.md)
•[schema/objects/transactions/retraction/StockRetraction](../objects/transactions/retraction/StockRetraction.md)
•[schema/objects/transactions/retraction/WarrantRetraction](../objects/transactions/retraction/WarrantRetraction.md)
•[schema/objects/transactions/return_to_pool/StockPlanReturnToPool](../objects/transactions/return_to_pool/StockPlanReturnToPool.md)
•[schema/objects/transactions/split/StockClassSplit](../objects/transactions/split/StockClassSplit.md)
•[schema/objects/transactions/adjustment/StockClassConversionRatioAdjustment](../objects/transactions/adjustment/StockClassConversionRatioAdjustment.md)
•[schema/objects/transactions/adjustment/StockClassAuthorizedSharesAdjustment](../objects/transactions/adjustment/StockClassAuthorizedSharesAdjustment.md)
•[schema/objects/transactions/transfer/ConvertibleTransfer](../objects/transactions/transfer/ConvertibleTransfer.md)
•[schema/objects/transactions/transfer/EquityCompensationTransfer](../objects/transactions/transfer/EquityCompensationTransfer.md)
•[schema/objects/transactions/transfer/StockTransfer](../objects/transactions/transfer/StockTransfer.md)
•[schema/objects/transactions/transfer/WarrantTransfer](../objects/transactions/transfer/WarrantTransfer.md)
•[schema/objects/transactions/vesting/VestingAcceleration](../objects/transactions/vesting/VestingAcceleration.md)
•[schema/objects/transactions/vesting/VestingStart](../objects/transactions/vesting/VestingStart.md)
•[schema/objects/transactions/vesting/VestingEvent](../objects/transactions/vesting/VestingEvent.md)
•[schema/objects/transactions/adjustment/StockPlanPoolAdjustment](../objects/transactions/adjustment/StockPlanPoolAdjustment.md) | List of OCF transaction objects | `REQUIRED` | **Source Code:** [schema/files/TransactionsFile](../../../../schema/files/TransactionsFile.schema.json) diff --git a/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md b/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md new file mode 100644 index 000000000..ed90c6f29 --- /dev/null +++ b/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md @@ -0,0 +1,54 @@ +:house: [Documentation Home](../../../../../README.md) + +--- + +### Object - Stock Consolidation Transaction + +`https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/objects/transactions/consolidation/StockConsolidation.schema.json` + +**Description:** _Object describing a the consolidation of multiple stock positions into one_ + +**Data Type:** `OCF Object - TX_STOCK_CONSOLIDATION` + +**Composed From:** + +- [schema/primitives/objects/Object](../../../primitives/objects/Object.md) +- [schema/primitives/objects/transactions/Transaction](../../../primitives/objects/transactions/Transaction.md) +- [schema/primitives/objects/transactions/consolidation/Consolidation](../../../primitives/objects/transactions/consolidation/Consolidation.md) + +**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 | **Constant:** `TX_STOCK_CONSOLIDATION`
_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` | +| security_ids | [`STRING`] | Identifier for the securities (stock, plan security, warrant, or convertible) that are being consolidated into one position by which it can be referenced by other transaction objects. Note that while this identifier is created with an issuance object, it should be different than the issuance object's `id` field which identifies the issuance transaction object itself. All future transactions on the security (e.g. acceptance, transfer, cancel, etc.) must reference this `security_id` to qualify which security the transaction applies to. | `REQUIRED` | +| resulting_security_id | `STRING` | Identifier of the new security issuance resulting from a consolidation | `REQUIRED` | +| reason_text | `STRING` | Free-form human-readable reason for stock consolidation | - | + +**Source Code:** [schema/objects/transactions/consolidation/StockConsolidation](../../../../../../schema/objects/transactions/consolidation/StockConsolidation.schema.json) + +**Examples:** + +```json +[ + { + "object_type": "TX_STOCK_CONSOLIDATION", + "id": "test-stock-consolidation-full-fields", + "security_ids": [ + "incoming-security-id-1", + "incoming-security-id-2" + ], + "date": "2022-02-01", + "resulting_security_ids": "resultant-security-id-1", + "comments": [ + "Here is a comment", + "Here is another comment" + ] + } +] +``` + +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 4b8814d7f..e57098605 100644 --- a/docs/schema_markdown/schema/primitives/objects/Object.md +++ b/docs/schema_markdown/schema/primitives/objects/Object.md @@ -12,11 +12,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_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_CONSOLIDATION
• 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/consolidation/Consolidation.md b/docs/schema_markdown/schema/primitives/objects/transactions/consolidation/Consolidation.md new file mode 100644 index 000000000..516e67595 --- /dev/null +++ b/docs/schema_markdown/schema/primitives/objects/transactions/consolidation/Consolidation.md @@ -0,0 +1,23 @@ +:house: [Documentation Home](../../../../../../README.md) + +--- + +### Primitive - Security Consolidation Transaction + +`https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json` + +**Description** _Abstract object describing common properties to a consolidation of a security_ + +**:warning: Primitives are Abstract and Should Not be Used for Data. They are used to enforce uniformity in OCF data types - specifically "types" and "objects". :warning:** + +**Properties:** + +| Property | Type | Description | Required | +| --------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | +| security_ids | [`STRING`] | Identifier for the securities (stock, plan security, warrant, or convertible) that are being consolidated into one position by which it can be referenced by other transaction objects. Note that while this identifier is created with an issuance object, it should be different than the issuance object's `id` field which identifies the issuance transaction object itself. All future transactions on the security (e.g. acceptance, transfer, cancel, etc.) must reference this `security_id` to qualify which security the transaction applies to. | `REQUIRED` | +| resulting_security_id | `STRING` | Identifier of the new security issuance resulting from a consolidation | `REQUIRED` | +| reason_text | `STRING` | Free-form human-readable reason for stock consolidation | - | + +**Source Code:** [schema/primitives/objects/transactions/consolidation/Consolidation](../../../../../../../schema/primitives/objects/transactions/consolidation/Consolidation.schema.json) + +Copyright © 2024 Open Cap Table Coalition. diff --git a/schema/objects/transactions/consolidation/StockConsolidation.schema.json b/schema/objects/transactions/consolidation/StockConsolidation.schema.json index 090651154..4df50a817 100644 --- a/schema/objects/transactions/consolidation/StockConsolidation.schema.json +++ b/schema/objects/transactions/consolidation/StockConsolidation.schema.json @@ -12,7 +12,7 @@ "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/Transaction.schema.json" }, { - "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/consolidation/consolidation.schema.json" + "$ref": "https://raw.githubusercontent.com/Open-Cap-Table-Coalition/Open-Cap-Format-OCF/main/schema/primitives/objects/transactions/consolidation/Consolidation.schema.json" } ], "properties": { From 0171894bcf2a8ef80bde0a08ad8e6a149b180c80 Mon Sep 17 00:00:00 2001 From: Arthur Guest Date: Tue, 26 Mar 2024 18:37:11 +0530 Subject: [PATCH 3/3] Fixed typo in sample transaction file --- .../objects/transactions/consolidation/StockConsolidation.md | 2 +- samples/Transactions.ocf.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md b/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md index ed90c6f29..80ec8124b 100644 --- a/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md +++ b/docs/schema_markdown/schema/objects/transactions/consolidation/StockConsolidation.md @@ -42,7 +42,7 @@ "incoming-security-id-2" ], "date": "2022-02-01", - "resulting_security_ids": "resultant-security-id-1", + "resulting_security_id": "resultant-security-id-1", "comments": [ "Here is a comment", "Here is another comment" diff --git a/samples/Transactions.ocf.json b/samples/Transactions.ocf.json index b5dea7003..a8a239dd7 100644 --- a/samples/Transactions.ocf.json +++ b/samples/Transactions.ocf.json @@ -1291,7 +1291,7 @@ "id": "test-stock-consolidation-full-fields", "security_ids": ["incoming-security-id-1", "incoming-security-id-2"], "date": "2022-02-01", - "resulting_security_ids": "resultant-security-id-1", + "resulting_security_id": "resultant-security-id-1", "comments": ["Here is a comment", "Here is another comment"] } ]