{ "openapi": "3.0.0", "info": { "title": "Allocations API", "description": "", "version": "1.0.0", "termsOfService": "https://allocations.com", "contact": { "name": "Allocations Support", "url": "https://allocations.com", "email": "support@allocations.com" } }, "paths": { "/closes/bulk": { "patch": { "x-controller-name": "ClosesController", "x-operation-name": "bulkUpdate", "tags": [ "Closes" ], "operationId": "bulkUpdateCloses", "responses": { "200": { "description": "Bulk update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "successCount": { "type": "number" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "error": { "type": "string" } }, "required": [ "id", "error" ] } } }, "required": [ "successCount", "failures" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateClosesDto" }, "minItems": 1, "maxItems": 500 } } } } } }, "/closes/{closeId}": { "get": { "x-controller-name": "ClosesController", "x-operation-name": "findById", "tags": [ "Closes" ], "operationId": "getCloseById", "responses": { "200": { "description": "Close model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosesWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Close request not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "closeId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the close request", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/closes.Filter" } } } } ] } }, "/closes": { "get": { "x-controller-name": "ClosesController", "x-operation-name": "find", "tags": [ "Closes" ], "operationId": "getCloses", "responses": { "200": { "description": "Array of Closes owned by the current user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClosesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/closes.Filter1" } } } } ] } }, "/deals/analytics": { "get": { "x-controller-name": "DealsController", "x-operation-name": "getDealsAnalytics", "tags": [ "Deals" ], "operationId": "getDealsAnalytics", "responses": { "200": { "description": "Successfully retrieved deals analytics", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "total": { "type": "number" }, "page": { "type": "number" }, "limit": { "type": "number" } }, "required": [ "data", "total", "page", "limit" ] } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "is_migration", "in": "query", "schema": { "type": "boolean" }, "description": "Filter deals by migration status" }, { "name": "status", "in": "query", "schema": { "type": "string" }, "description": "Filter deals by status" }, { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Filter deals by type" }, { "name": "fields", "in": "query", "schema": { "type": "string" }, "description": "Comma-separated list of fields to include in response" }, { "name": "page", "in": "query", "schema": { "type": "number" }, "description": "Page number for pagination", "example": 1 }, { "name": "limit", "in": "query", "schema": { "type": "number" }, "description": "Number of items per page", "example": 50 } ] } }, "/deals/closes/{closeId}": { "patch": { "x-controller-name": "DealsController", "x-operation-name": "updateCloseById", "tags": [ "Deals" ], "operationId": "updateCloseById", "responses": { "204": { "description": "Successfully updated close request" }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Close request not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "closeId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the close request", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosesPartial" } } }, "x-parameter-index": 1 } } }, "/deals/secondary-requests": { "get": { "x-controller-name": "SecondaryRequestsController", "x-operation-name": "find", "tags": [ "Deals" ], "operationId": "listSecondaryRequests", "responses": { "200": { "description": "Secondary requests retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SecondaryRequestsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecondaryRequests.Filter" } } } } ] } }, "/deals/summary": { "get": { "x-controller-name": "DealsController", "x-operation-name": "getDealsSummary", "tags": [ "Deals" ], "operationId": "getDealsSummary", "responses": { "200": { "description": "Successfully retrieved deals summary for the current user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealSummaryWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter" } } } } ] } }, "/deals/{dealId}/assets/{assetId}": { "get": { "x-controller-name": "DealsController", "x-operation-name": "findAssetByIdForDeal", "tags": [ "Deals" ], "operationId": "getAssetByIdForDeal", "responses": { "200": { "description": "Successfully retrieved asset details for the deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Asset not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "assetId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the asset", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assets.Filter" } } } } ] } }, "/deals/{dealId}/assets": { "get": { "x-controller-name": "DealsController", "x-operation-name": "findAssetsForDeal", "tags": [ "Deals" ], "operationId": "getAssetsForDeal", "responses": { "200": { "description": "Successfully retrieved assets for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assets.Filter1" } } } } ] } }, "/deals/{dealId}/closes": { "get": { "x-controller-name": "DealsController", "x-operation-name": "findDealCloses", "tags": [ "Deals" ], "operationId": "getDealCloses", "responses": { "200": { "description": "Successfully retrieved close requests for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter" } } } } ] } }, "/deals/{dealId}/create-close-request": { "post": { "x-controller-name": "DealsController", "x-operation-name": "createDealCloseRequest", "tags": [ "Deals" ], "operationId": "createCloseRequest", "responses": { "200": { "description": "Successfully created close request for the deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClosesWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCloseRequest" } } }, "x-parameter-index": 1 } } }, "/deals/{dealId}/create-invitation": { "post": { "x-controller-name": "DealsController", "x-operation-name": "createInvitation", "tags": [ "Deals" ], "operationId": "createInvitation", "responses": { "200": { "description": "Successfully created and sent invitation for the deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationsWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInvitation" } } }, "x-parameter-index": 1 } } }, "/deals/{id}/details": { "patch": { "x-controller-name": "DealsController", "x-operation-name": "updateDealDetailsByDealId", "tags": [ "Deals" ], "operationId": "updateDealDetailsByDealId", "responses": { "204": { "description": "Successfully updated deal details" }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDetailsPartial" } } }, "x-parameter-index": 1 } } }, "/deals/{dealId}/details": { "get": { "x-controller-name": "DealsController", "x-operation-name": "getDealDetailsByDealId", "tags": [ "Deals" ], "operationId": "getDealDetailsByDealId", "responses": { "200": { "description": "Deal details for the specified deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDetailsWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDetails.Filter" } } } } ] } }, "/deals/{dealId}/files": { "get": { "x-controller-name": "DealsController", "x-operation-name": "getDealFiles", "tags": [ "Deals" ], "operationId": "getDealFiles", "responses": { "200": { "description": "Successfully retrieved files for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Files" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files.Filter" } } } } ] } }, "/deals/{dealId}/invest/{identityId}": { "post": { "x-controller-name": "DealsController", "x-operation-name": "saveInvestmentAndCreateSubscription", "tags": [ "Deals" ], "operationId": "saveInvestmentAndCreateSubscription", "responses": { "200": { "description": "Successfully created subscription agreement and saved investment", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "preview", "in": "query", "schema": { "type": "boolean" }, "description": "Whether to preview the subscription agreement", "example": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number" } } } } }, "x-parameter-index": 3 } } }, "/deals/{dealId}/investments": { "get": { "x-controller-name": "DealsController", "x-operation-name": "findDealInvestments", "tags": [ "Deals" ], "operationId": "getDealInvestments", "responses": { "200": { "description": "Successfully retrieved investments for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Investments.Filter" } } } } ] } }, "/deals/{dealId}/investors/documents/download": { "get": { "x-controller-name": "DealsController", "x-operation-name": "downloadInvestorFiles", "tags": [ "Deals" ], "operationId": "downloadInvestorFiles", "responses": { "200": { "description": "Successfully downloaded investor files as ZIP archive", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/deals/{dealId}/invitations": { "get": { "x-controller-name": "DealsController", "x-operation-name": "findDealInvitations", "tags": [ "Deals" ], "operationId": "getDealInvitations", "responses": { "200": { "description": "Successfully retrieved invitations for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvitationsWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitations.Filter" } } } } ] } }, "/deals/{dealId}/secondary-requests": { "post": { "x-controller-name": "SecondaryRequestsController", "x-operation-name": "create", "tags": [ "Deals" ], "operationId": "createSecondaryRequest", "responses": { "200": { "description": "Secondary request created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecondaryRequestsWithRelations" } } } }, "400": { "description": "Invalid secondary request data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "409": { "description": "A secondary request already exists for this deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSecondaryRequests" } } } } } }, "/deals/{dealId}/submit": { "post": { "x-controller-name": "DealsController", "x-operation-name": "submitDeal", "tags": [ "Deals" ], "operationId": "submitDeal", "responses": { "204": { "description": "Successfully submitted deal for processing" }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/deals/{dealId}/upload-file": { "post": { "x-controller-name": "DealsController", "x-operation-name": "uploadDealFile", "tags": [ "Deals" ], "operationId": "uploadDealFile", "responses": { "200": { "description": "Successfully uploaded file for the deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Files" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "413": { "description": "File too large", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "415": { "description": "Unsupported file type", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "fileType": { "type": "string", "enum": [ "1065", "MSA", "advisory-agreement", "bank-statements", "custom-docs", "fund-agreement", "investor-ledger", "certificate-of-formation", "series-operating-agreement", "k-1", "logo", "operational-agreement", "order-form", "pitch-deck", "portfolio-wire-instructions", "purchase-agreement", "services-agreement", "spv-agreement", "subscription-agreement", "tax-return", "term-sheet", "upload", "wire-instructions" ] }, "replaceFile": { "type": "boolean" } } } } } } } }, "/deals/{dealId}/views": { "post": { "x-controller-name": "DealsController", "x-operation-name": "createDealView", "tags": [ "Deals" ], "operationId": "createDealView", "responses": { "200": { "description": "Successfully created view record for the deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsViews" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] }, "get": { "x-controller-name": "DealsController", "x-operation-name": "getDealViews", "tags": [ "Deals" ], "operationId": "getDealViews", "responses": { "200": { "description": "Successfully retrieved view records for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealsViews" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsViews.Filter" } } } } ] } }, "/deals/{dealId}": { "patch": { "x-controller-name": "DealsController", "x-operation-name": "updateById", "tags": [ "Deals" ], "operationId": "updateDealById", "responses": { "204": { "description": "Successfully updated deal" }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsPartial" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "DealsController", "x-operation-name": "findById", "tags": [ "Deals" ], "operationId": "getDealById", "responses": { "200": { "description": "Successfully retrieved deal details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter1" } } } } ] } }, "/deals": { "post": { "x-controller-name": "DealsController", "x-operation-name": "create", "tags": [ "Deals" ], "operationId": "createDeal", "responses": { "200": { "description": "Successfully created a new deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDeals" } } } } }, "get": { "x-controller-name": "DealsController", "x-operation-name": "find", "tags": [ "Deals" ], "operationId": "getDeals", "responses": { "200": { "description": "Successfully retrieved deals for the current user", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Deals.Filter" } } } } ] } }, "/documents/master-service-agreement/{organizationId}/{dealId}/sign": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "signMasterServiceAgreement", "tags": [ "Documents" ], "operationId": "signMasterServiceAgreement", "responses": { "200": { "description": "Master Service Agreement signed successfully", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid organization ID, deal ID, or signing failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "dealId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/documents/master-service-agreement": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "createMasterServiceAgreement", "tags": [ "Documents" ], "operationId": "createMasterServiceAgreement", "responses": { "200": { "description": "Master Service Agreement PDF generated successfully", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Document generation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "preview", "in": "query", "schema": { "type": "boolean" } } ] } }, "/documents/memorandum-of-understanding/{organizationId}": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "createMOUDocument", "tags": [ "Documents" ], "operationId": "createMOUDocument", "responses": { "200": { "description": "Memorandum of Understanding document path generated successfully", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid organization ID or document generation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "preview", "in": "query", "schema": { "type": "boolean" } } ] } }, "/documents/subscription-agreement/preview/{dealId}": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "createSubscriptionAgreementDocumentPreview", "tags": [ "Documents" ], "operationId": "previewSubscriptionAgreement", "responses": { "200": { "description": "Subscription Agreement preview generated successfully", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid deal ID or preview generation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "preview", "in": "query", "schema": { "type": "boolean" } } ] } }, "/documents/terms-and-conditions/{organizationId}": { "post": { "x-controller-name": "DocumentsController", "x-operation-name": "createTermsAndConditions", "tags": [ "Documents" ], "operationId": "createTermsAndConditions", "responses": { "200": { "description": "Terms and Conditions document path generated successfully", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid organization ID or document generation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "organizationId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "preview", "in": "query", "schema": { "type": "boolean" } } ] } }, "/files/download/{fileId}": { "get": { "x-controller-name": "FilesController", "x-operation-name": "downloadFile", "tags": [ "Files" ], "operationId": "downloadFile", "responses": { "200": { "description": "File downloaded successfully", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid file ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "File not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "fileId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the file", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/files/download-bulk": { "post": { "x-controller-name": "FilesController", "x-operation-name": "downloadBulkFiles", "tags": [ "Files" ], "operationId": "downloadBulkFiles", "responses": { "200": { "description": "Bulk files downloaded successfully as ZIP", "content": { "application/zip": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid file IDs", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Files not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } }, "/identities/{identityId}/archive": { "patch": { "x-controller-name": "IdentitiesController", "x-operation-name": "archive", "tags": [ "Identities" ], "operationId": "archiveIdentity", "responses": { "200": { "description": "Identity archived successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identities" } } } }, "400": { "description": "Invalid request - identity cannot be archived", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/investments/sell-order-requests": { "get": { "x-controller-name": "SellOrderRequestsController", "x-operation-name": "find", "tags": [ "Investments" ], "operationId": "listSellOrderRequests", "responses": { "200": { "description": "Sell order requests retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SellOrderRequestsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellOrderRequests.Filter" } } } } ] } }, "/investments/{investmentId}/sell-order-request": { "post": { "x-controller-name": "SellOrderRequestsController", "x-operation-name": "create", "tags": [ "Investments" ], "operationId": "createSellOrderRequest", "responses": { "200": { "description": "Sell order request created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SellOrderRequestsWithRelations" } } } }, "400": { "description": "Invalid sell order request data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Investment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "409": { "description": "A sell order request already exists for this investment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericError" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "investmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSellOrderRequests" } } } } } }, "/investments/{id}/{transferInformationId}": { "post": { "x-controller-name": "InvestmentsController", "x-operation-name": "linkInvestmentToTransferInformation", "tags": [ "Investments" ], "operationId": "linkInvestmentToTransferInformation", "responses": { "200": { "description": "Investment linked to transfer information successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestmentTransferInformation" } } } }, "400": { "description": "Invalid investment ID or transfer information ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Investment or transfer information not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "transferInformationId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the transfer information", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/investments/{id}": { "patch": { "x-controller-name": "InvestmentsController", "x-operation-name": "updateById", "tags": [ "Investments" ], "operationId": "updateInvestmentById", "responses": { "204": { "description": "Investment updated successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Investment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateInvestmentByIdBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "InvestmentsController", "x-operation-name": "findById", "tags": [ "Investments" ], "operationId": "getInvestmentById", "responses": { "200": { "description": "Investment retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Investment" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Investment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Investments.Filter1" } } } } ] } }, "/investments": { "get": { "x-controller-name": "InvestmentsController", "x-operation-name": "find", "tags": [ "Investments" ], "operationId": "getInvestments", "responses": { "200": { "description": "Investments retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Investment" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Investments.Filter" } } } } ] } }, "/investors": { "get": { "x-controller-name": "InvestmentsController", "x-operation-name": "findInvestors", "tags": [ "Investments" ], "operationId": "getInvestors", "responses": { "200": { "description": "Investors retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "legalName": { "type": "string" }, "email": { "type": "string" }, "totalInvested": { "type": "number" }, "dealCount": { "type": "number" } } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Investments.Filter" } } } } ] } }, "/ledgers/by-entity/{entityId}": { "get": { "x-controller-name": "LedgerController", "x-operation-name": "getLedgerByEntityId", "tags": [ "Ledger" ], "operationId": "getLedgerByEntityId", "responses": { "200": { "description": "Ledger with balances retrieved successfully", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Ledger" }, { "type": "object", "properties": { "totalBalances": { "type": "object", "additionalProperties": { "type": "number" }, "description": "Total balance per currency for the ledger" }, "accounts": { "type": "array", "items": { "allOf": [ { "$ref": "#/components/schemas/LedgerAccount" }, { "type": "object", "properties": { "balance": { "type": "number" } } } ] }, "description": "Accounts for the ledger, each with its balance" } } } ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "entityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledgers.Filter" } } } } ] } }, "/ledgers/migrate/{entityId}": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "migrateLegacyLedger", "tags": [ "Ledger" ], "operationId": "migrateLegacyLedger", "responses": { "200": { "description": "Run the ledger migration script" } }, "parameters": [ { "name": "entityId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/accounts/{accountId}/entries": { "get": { "x-controller-name": "LedgerController", "x-operation-name": "getEntriesByAccountId", "tags": [ "Ledger" ], "operationId": "getLedgerEntriesByAccountId", "responses": { "200": { "description": "Ledger entries for account retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "accountId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/accounts/{accountId}/{objectId}": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "createLedgerAccountAssociation", "tags": [ "Ledger" ], "operationId": "createLedgerAccountAssociation", "responses": { "200": { "description": "Ledger account association created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccountAssociation" } } } }, "400": { "description": "Invalid association data or creation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "accountId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "objectId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "associationType" ], "properties": { "associationType": { "type": "string" } } } } } } } }, "/ledgers/{ledgerId}/accounts/{accountId}": { "get": { "x-controller-name": "LedgerController", "x-operation-name": "getAccountAssociations", "tags": [ "Ledger" ], "operationId": "getLedgerAccountAssociations", "responses": { "200": { "description": "Ledger account associations retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountAssociation" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "accountId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] }, "delete": { "x-controller-name": "LedgerController", "x-operation-name": "deleteLedgerAccountById", "tags": [ "Ledger" ], "operationId": "deleteLedgerAccountByAccountId", "responses": { "200": { "description": "Ledger account deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "accountId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/accounts": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "createAccount", "tags": [ "Ledger" ], "operationId": "createLedgerAccount", "responses": { "200": { "description": "Ledger account created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerAccount" } } } }, "400": { "description": "Invalid account data or creation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ledgerId", "name", "referenceNumberId", "creditOrDebit", "currency" ], "properties": { "name": { "type": "string" }, "referenceNumberId": { "type": "string" }, "creditOrDebit": { "type": "string" }, "currency": { "type": "string" }, "parentAccountId": { "type": "string" } } } } } } }, "get": { "x-controller-name": "LedgerController", "x-operation-name": "getAccountsByLedgerId", "tags": [ "Ledger" ], "operationId": "getAccountsByLedgerId", "responses": { "200": { "description": "Ledger accounts retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccount" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/entries/same_sign": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "createSameSignEntry", "tags": [ "Ledger" ], "operationId": "createSameSignLedgerEntry", "responses": { "200": { "description": "Ledger entry created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "additiveEntry": { "$ref": "#/components/schemas/LedgerEntry" }, "subtractiveEntry": { "$ref": "#/components/schemas/LedgerEntry" } } } } } }, "400": { "description": "Invalid entry data or creation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ledgerId", "fromAccountId", "toAccountId", "amount", "date", "description" ], "properties": { "fromAccountId": { "type": "string" }, "toAccountId": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" }, "date": { "type": "string", "format": "date" } } } } } } } }, "/ledgers/{ledgerId}/entries/{entryId}": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "editEntry", "tags": [ "Ledger" ], "operationId": "updateLedgerEntry", "responses": { "200": { "description": "Ledger entry updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "additiveEntry": { "$ref": "#/components/schemas/LedgerEntry" }, "subtractiveEntry": { "$ref": "#/components/schemas/LedgerEntry" } } } } } }, "400": { "description": "Invalid entry data or update failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entry not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "entryId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ledgerId", "fromAccountId", "toAccountId", "amount", "date", "description" ], "properties": { "fromAccountId": { "type": "string" }, "toAccountId": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" }, "date": { "type": "string", "format": "date" } } } } } } }, "delete": { "x-controller-name": "LedgerController", "x-operation-name": "deleteLedgerEntryById", "tags": [ "Ledger" ], "operationId": "deleteLedgerEntryByEntryId", "responses": { "200": { "description": "Ledger entry deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entry not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "entryId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/entries": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "createEntry", "tags": [ "Ledger" ], "operationId": "createLedgerEntry", "responses": { "200": { "description": "Ledger entry created successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "additiveEntry": { "$ref": "#/components/schemas/LedgerEntry" }, "subtractiveEntry": { "$ref": "#/components/schemas/LedgerEntry" } } } } } }, "400": { "description": "Invalid entry data or creation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ledgerId", "fromAccountId", "toAccountId", "amount", "date", "description" ], "properties": { "fromAccountId": { "type": "string" }, "toAccountId": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" }, "date": { "type": "string", "format": "date" } } } } } } }, "get": { "x-controller-name": "LedgerController", "x-operation-name": "getEntriesByLedgerId", "tags": [ "Ledger" ], "operationId": "getLedgerEntriesByLedgerId", "responses": { "200": { "description": "Ledger entries retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LedgerEntries.Filter" } } } } ] } }, "/ledgers/{ledgerId}/reconcile": { "get": { "x-controller-name": "LedgerController", "x-operation-name": "getUncategorizedEntries", "tags": [ "Ledger" ], "operationId": "getUncategorizedEntries", "responses": { "200": { "description": "Uncategorized ledger entries retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Ledger not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/ledgers/{ledgerId}/transactions/{transactionId}": { "post": { "x-controller-name": "LedgerController", "x-operation-name": "attachTransactionToLedger", "tags": [ "Ledger" ], "operationId": "attachTransactionToLedger", "responses": { "200": { "description": "Transaction attached to ledger successfully", "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "additiveEntry": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" }, "subtractiveEntry": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } }, { "type": "object", "properties": { "uncategorizedEntry": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } } ] } } } }, "400": { "description": "Invalid transaction data or attachment failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Transaction not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "ledgerId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "transactionId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "fromAccountId", "toAccountId" ], "properties": { "fromAccountId": { "type": "string" }, "toAccountId": { "type": "string" } } } } }, "x-parameter-index": 2 } } }, "/providers/{provider}/check-status": { "get": { "x-controller-name": "ProvidersController", "x-operation-name": "checkProvider", "tags": [ "Providers" ], "operationId": "checkProviderStatus", "responses": { "200": { "description": "True if provider is accessible and token is valid, false otherwise", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Invalid provider or parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string", "enum": [ "CCH" ], "description": "Provider identifier" }, "required": true } ] } }, "/providers/{provider}/renew-token": { "post": { "x-controller-name": "ProvidersController", "x-operation-name": "renewToken", "tags": [ "Providers" ], "operationId": "renewProviderToken", "responses": { "200": { "description": "URL to redirect user to for OAuth token renewal", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid provider or parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string", "enum": [ "CCH" ], "description": "Provider identifier" }, "required": true } ] } }, "/providers/{provider}/token": { "get": { "x-controller-name": "ProvidersController", "x-operation-name": "ingestToken", "tags": [ "Providers" ], "operationId": "ingestProviderToken", "responses": { "200": { "description": "True if token was successfully ingested and stored, false otherwise", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "400": { "description": "Invalid provider or parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Provider credentials not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "provider", "in": "path", "schema": { "type": "string", "enum": [ "CCH" ], "description": "Provider identifier" }, "required": true }, { "name": "code", "in": "query", "schema": { "type": "string", "description": "OAuth authorization code from provider" }, "required": true } ] } }, "/static-reference/ISO-3166/countries": { "get": { "x-controller-name": "StaticReferenceController", "x-operation-name": "getCountries", "tags": [ "Static References" ], "operationId": "getCountriesReference", "responses": { "200": { "description": "ISO 3166 country codes retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Country name" }, "iso": { "type": "string", "description": "ISO 3166 country code" } } } } } } }, "400": { "description": "Invalid request parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/static-reference/ISO-3166/{countryCode}/regions": { "get": { "x-controller-name": "StaticReferenceController", "x-operation-name": "getRegions", "tags": [ "Static References" ], "operationId": "getRegionsReference", "responses": { "200": { "description": "ISO 3166 region codes for the specified country retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Region name" }, "iso": { "type": "string", "description": "ISO 3166 region code" } } } } } } }, "400": { "description": "Invalid country code format", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Country code not found or no regions available", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "countryCode", "in": "path", "schema": { "type": "string" }, "description": "ISO 3166 country code (e.g., US, CA, GB)", "example": "US", "required": true } ] } }, "/transfer-requests/bulk": { "patch": { "x-controller-name": "TransferRequestController", "x-operation-name": "bulkUpdate", "tags": [ "Transfer Requests" ], "operationId": "bulkUpdateTransferRequests", "responses": { "200": { "description": "Bulk update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "successCount": { "type": "number" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "error": { "type": "string" } }, "required": [ "id", "error" ] } } }, "required": [ "successCount", "failures" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateTransferRequestDto" }, "minItems": 1, "maxItems": 500 } } } } } }, "/transfer-requests/count": { "get": { "x-controller-name": "TransferRequestController", "x-operation-name": "count", "tags": [ "Transfer Requests" ], "operationId": "getTransferRequestCount", "responses": { "200": { "description": "TransferRequest count retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TransferRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ] } }, "/transfer-requests/{id}": { "patch": { "x-controller-name": "TransferRequestController", "x-operation-name": "updateById", "tags": [ "Transfer Requests" ], "operationId": "updateTransferRequestById", "responses": { "204": { "description": "TransferRequest updated successfully" }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "TransferRequest not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the transfer request", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequestPartial" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "TransferRequestController", "x-operation-name": "findById", "tags": [ "Transfer Requests" ], "operationId": "getTransferRequestById", "responses": { "200": { "description": "TransferRequest model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequestWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "TransferRequest not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the transfer request", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequest.Filter" } } } } ] }, "delete": { "x-controller-name": "TransferRequestController", "x-operation-name": "deleteById", "tags": [ "Transfer Requests" ], "operationId": "deleteTransferRequestById", "responses": { "204": { "description": "TransferRequest deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "TransferRequest not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the transfer request", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/transfer-requests": { "get": { "x-controller-name": "TransferRequestController", "x-operation-name": "find", "tags": [ "Transfer Requests" ], "operationId": "getTransferRequests", "responses": { "200": { "description": "Array of TransferRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRequestWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequest.Filter1" } } } } ] } }, "/v1/announcements/{id}": { "patch": { "x-controller-name": "AnnouncementsController", "x-operation-name": "updateById", "tags": [ "Announcements" ], "operationId": "updateAnnouncement", "responses": { "200": { "description": "Announcement updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcements" } } } }, "400": { "description": "Invalid announcement data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Announcement not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the announcement", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAnnouncementRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "AnnouncementsController", "x-operation-name": "findById", "tags": [ "Announcements" ], "operationId": "getAnnouncementById", "responses": { "200": { "description": "Announcement retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcements" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Announcement not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the announcement", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcements.Filter" } } } } ] }, "delete": { "x-controller-name": "AnnouncementsController", "x-operation-name": "deleteById", "tags": [ "Announcements" ], "operationId": "deleteAnnouncement", "responses": { "204": { "description": "Announcement deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Announcement not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the announcement", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v1/announcements": { "post": { "x-controller-name": "AnnouncementsController", "x-operation-name": "create", "tags": [ "Announcements" ], "operationId": "createAnnouncement", "responses": { "200": { "description": "Announcement created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcements" } } } }, "400": { "description": "Invalid announcement data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnouncementRequestBody" } } } } }, "get": { "x-controller-name": "AnnouncementsController", "x-operation-name": "find", "tags": [ "Announcements" ], "operationId": "getAnnouncements", "responses": { "200": { "description": "Announcements retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Announcements" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Announcements.Filter1" } } } } ] } }, "/v1/assets/{id}": { "patch": { "x-controller-name": "AssetsController", "x-operation-name": "updateById", "tags": [ "Assets" ], "operationId": "updateAsset", "responses": { "204": { "description": "Asset updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Asset not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the asset", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAssetRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "AssetsController", "x-operation-name": "findById", "tags": [ "Assets" ], "operationId": "getAssetById", "responses": { "200": { "description": "Asset model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Asset not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the asset", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assets.Filter" } } } } ] }, "delete": { "x-controller-name": "AssetsController", "x-operation-name": "deleteById", "tags": [ "Assets" ], "operationId": "deleteAsset", "responses": { "204": { "description": "Asset deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Asset not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the asset", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v1/assets": { "post": { "x-controller-name": "AssetsController", "x-operation-name": "create", "tags": [ "Assets" ], "operationId": "createAsset", "responses": { "200": { "description": "Asset model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsWithRelations" } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAssetRequestBody" } } } } }, "get": { "x-controller-name": "AssetsController", "x-operation-name": "find", "tags": [ "Assets" ], "operationId": "getAssets", "responses": { "200": { "description": "Array of Assets model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Assets.Filter1" } } } } ] } }, "/v1/distributions/bulk": { "patch": { "x-controller-name": "DistributionsController", "x-operation-name": "bulkUpdate", "tags": [ "Distributions" ], "operationId": "bulkUpdateDistributions", "responses": { "200": { "description": "Bulk update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "successCount": { "type": "number" }, "failures": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "error": { "type": "string" } }, "required": [ "id", "error" ] } } }, "required": [ "successCount", "failures" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateDistributionsDto" }, "minItems": 1, "maxItems": 500 } } } } } }, "/v1/distributions/{id}": { "patch": { "x-controller-name": "DistributionsController", "x-operation-name": "updateById", "tags": [ "Distributions" ], "operationId": "updateDistributionsById", "responses": { "204": { "description": "Distribution updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Distribution not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistributionDto" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "DistributionsController", "x-operation-name": "findById", "tags": [ "Distributions" ], "operationId": "getDistributionsById", "responses": { "200": { "description": "Distribution model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Distribution" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Distribution not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Distributions.Filter" } } } } ] }, "delete": { "x-controller-name": "DistributionsController", "x-operation-name": "deleteById", "tags": [ "Distributions" ], "operationId": "deleteDistributionsById", "responses": { "204": { "description": "Distribution deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Distribution not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v1/distributions": { "post": { "x-controller-name": "DistributionsController", "x-operation-name": "create", "tags": [ "Distributions" ], "operationId": "createDistributions", "responses": { "200": { "description": "Distribution model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Distribution" } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistributionDto" } } } } }, "get": { "x-controller-name": "DistributionsController", "x-operation-name": "find", "tags": [ "Distributions" ], "operationId": "getDistributions", "responses": { "200": { "description": "Array of Distribution model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Distribution" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Distributions.Filter1" } } } } ] } }, "/v1/distributions-investments/{id}": { "patch": { "x-controller-name": "DistributionsInvestmentsController", "x-operation-name": "updateById", "tags": [ "DistributionsInvestments" ], "operationId": "updateDistributionsInvestmentsById", "responses": { "204": { "description": "Distribution investment updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "DistributionInvestment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDistributionInvestmentDto" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "DistributionsInvestmentsController", "x-operation-name": "findById", "tags": [ "DistributionsInvestments" ], "operationId": "getDistributionsInvestmentsById", "responses": { "200": { "description": "DistributionInvestment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsInvestmentsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "DistributionInvestment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsInvestments.Filter" } } } } ] }, "delete": { "x-controller-name": "DistributionsInvestmentsController", "x-operation-name": "deleteById", "tags": [ "DistributionsInvestments" ], "operationId": "deleteDistributionsInvestmentsById", "responses": { "204": { "description": "Distribution investment deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "DistributionInvestment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the distribution investment", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v1/distributions-investments": { "post": { "x-controller-name": "DistributionsInvestmentsController", "x-operation-name": "create", "tags": [ "DistributionsInvestments" ], "operationId": "createDistributionsInvestments", "responses": { "200": { "description": "DistributionInvestment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsInvestmentsWithRelations" } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Distribution not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDistributionInvestmentDto" } } } } }, "get": { "x-controller-name": "DistributionsInvestmentsController", "x-operation-name": "find", "tags": [ "DistributionsInvestments" ], "operationId": "getDistributionsInvestments", "responses": { "200": { "description": "Array of DistributionInvestment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionsInvestmentsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistributionsInvestments.Filter1" } } } } ] } }, "/v1/transfer-information/identities/{identityId}": { "get": { "x-controller-name": "TransferInformationController", "x-operation-name": "findByIdentityId", "tags": [ "TransferInformation" ], "operationId": "getTransferInformationByIdentityId", "responses": { "200": { "description": "Transfer information for identity retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } } } }, "400": { "description": "Invalid identity ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Identity ID to get transfer information for", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformation.Filter" } } } } ] } }, "/v1/transfer-information/{id}": { "patch": { "x-controller-name": "TransferInformationController", "x-operation-name": "updateById", "tags": [ "TransferInformation" ], "operationId": "updateTransferInformation", "responses": { "204": { "description": "Transfer information updated successfully" }, "400": { "description": "Invalid transfer information data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Transfer Information not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Transfer information ID to update", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformationPartialExcluding_id-createdAt-updatedAt-deleted-deletedOn-deletedBy_" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "TransferInformationController", "x-operation-name": "findById", "tags": [ "TransferInformation" ], "operationId": "getTransferInformationById", "responses": { "200": { "description": "TransferInformation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } } }, "400": { "description": "Invalid transfer information ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Transfer Information not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Transfer information ID", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformation.Filter1" } } } } ] }, "delete": { "x-controller-name": "TransferInformationController", "x-operation-name": "deleteById", "tags": [ "TransferInformation" ], "operationId": "deleteTransferInformation", "responses": { "204": { "description": "Transfer information deleted successfully" }, "400": { "description": "Invalid transfer information ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Transfer Information not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Transfer information ID to delete", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v1/transfer-information": { "post": { "x-controller-name": "TransferInformationController", "x-operation-name": "create", "tags": [ "TransferInformation" ], "operationId": "createTransferInformation", "responses": { "200": { "description": "TransferInformation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } } }, "400": { "description": "Invalid transfer information data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransferInformation" } } } } }, "get": { "x-controller-name": "TransferInformationController", "x-operation-name": "find", "tags": [ "TransferInformation" ], "operationId": "getTransferInformation", "responses": { "200": { "description": "Array of TransferInformation model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferInformation.Filter" } } } } ] } }, "/v2/accreditations/identity/{identityId}": { "get": { "x-controller-name": "AccreditationsController", "x-operation-name": "findByIdentityId", "tags": [ "Accreditations" ], "operationId": "getAccreditationsByIdentityId", "responses": { "200": { "description": "Array of accreditations for the specified identity", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccreditationsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string", "format": "uuid", "description": "Identity ID" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accreditations.Filter" } } } } ] } }, "/v2/accreditations/{id}": { "patch": { "x-controller-name": "AccreditationsController", "x-operation-name": "updateById", "tags": [ "Accreditations" ], "operationId": "updateAccreditation", "responses": { "204": { "description": "Accreditation updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Accreditation not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "format": "uuid", "description": "Accreditation ID" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccreditationRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "AccreditationsController", "x-operation-name": "findById", "tags": [ "Accreditations" ], "operationId": "getAccreditationById", "responses": { "200": { "description": "Accreditation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccreditationsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Accreditation not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "format": "uuid", "description": "Accreditation ID" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accreditations.Filter" } } } } ] }, "delete": { "x-controller-name": "AccreditationsController", "x-operation-name": "softDelete", "tags": [ "Accreditations" ], "operationId": "softDeleteAccreditation", "responses": { "204": { "description": "Accreditation deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Accreditation not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string", "format": "uuid", "description": "Accreditation ID" }, "required": true } ] } }, "/v2/accreditations": { "post": { "x-controller-name": "AccreditationsController", "x-operation-name": "create", "tags": [ "Accreditations" ], "operationId": "createAccreditation", "responses": { "200": { "description": "Accreditation model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccreditationsWithRelations" } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccreditationRequestBody" } } } } }, "get": { "x-controller-name": "AccreditationsController", "x-operation-name": "find", "tags": [ "Accreditations" ], "operationId": "getAccreditations", "responses": { "200": { "description": "Array of Accreditation model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccreditationsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Accreditations.Filter1" } } } } ] } }, "/v2/bank-accounts/available-providers/{assetType}": { "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "getAvailableProviders", "tags": [ "Banking" ], "operationId": "getAvailableProviders", "responses": { "200": { "description": "Available providers retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "enum": [ "LAYER2", "FORTRESS_TRUST" ] } } } } }, "400": { "description": "Invalid asset type", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "assetType", "in": "path", "schema": { "type": "string", "enum": [ "USD", "USDC", "USDT" ], "description": "Asset Type" }, "required": true } ] } }, "/v2/bank-accounts/bank-accounts/count": { "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "count", "tags": [ "Banking" ], "operationId": "getBankAccountsCount", "responses": { "200": { "description": "Bank account count retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BankAccounts.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ] } }, "/v2/bank-accounts/bank-accounts/updates-required-count": { "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "updatesRequiredAccounts", "tags": [ "Banking" ], "operationId": "getUpdatesRequiredBankAccounts", "responses": { "200": { "description": "Count of bank accounts requiring updates retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/bank-accounts/bank-accounts/{id}": { "patch": { "x-controller-name": "BankAccountsController", "x-operation-name": "updateById", "tags": [ "Banking" ], "operationId": "updateBankAccountById", "responses": { "200": { "description": "Bank account updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Bank account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the bank account", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateBankAccountRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "findById", "tags": [ "Banking" ], "operationId": "getBankAccountById", "responses": { "200": { "description": "Bank account retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Bank account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the bank account", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccounts.Filter" } } } } ] } }, "/v2/bank-accounts/bank-accounts": { "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "find", "tags": [ "Banking" ], "operationId": "getBankAccounts", "responses": { "200": { "description": "Array of bank accounts retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BankAccountsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccounts.Filter1" } } } } ] } }, "/v2/bank-accounts/create-application": { "post": { "x-controller-name": "BankAccountsController", "x-operation-name": "applyForAccount", "tags": [ "Banking" ], "operationId": "createApplication", "responses": { "200": { "description": "Bank account application created successfully" }, "400": { "description": "Invalid application data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "entityId", "beneficialOwnerId", "provider" ], "properties": { "entityId": { "type": "string", "format": "uuid" }, "beneficialOwnerId": { "type": "string", "format": "uuid" }, "controlPersonId": { "type": "string", "format": "uuid", "nullable": true }, "assetType": { "type": "string", "enum": [ "USD", "USDC", "USDT" ] }, "provider": { "type": "string", "enum": [ "LAYER2" ] } } } } } } } }, "/v2/bank-accounts/{id}/request-sync": { "get": { "x-controller-name": "BankAccountsController", "x-operation-name": "getAccount", "tags": [ "Banking" ], "operationId": "requestBankAccountSync", "responses": { "200": { "description": "Bank account sync requested successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankAccountsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Bank account not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the bank account", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/entities/{id}/taxes": { "get": { "x-controller-name": "EntitiesController", "x-operation-name": "getEntityTaxesByEntityId", "tags": [ "Entities" ], "operationId": "getEntityTaxesByEntityId", "responses": { "200": { "description": "Successfully retrieved taxes for the entity", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesTaxesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the entity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesTaxes.Filter" } } } } ] } }, "/v2/entities/{id}": { "patch": { "x-controller-name": "EntitiesController", "x-operation-name": "updateById", "tags": [ "Entities" ], "operationId": "updateEntity", "responses": { "204": { "description": "Entity updated successfully" }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the entity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEntityRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "EntitiesController", "x-operation-name": "findById", "tags": [ "Entities" ], "operationId": "getEntityById", "responses": { "200": { "description": "Entity retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the entity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entities.Filter" } } } } ] } }, "/v2/entities": { "post": { "x-controller-name": "EntitiesController", "x-operation-name": "create", "tags": [ "Entities" ], "operationId": "createEntity", "responses": { "200": { "description": "Entity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntitiesWithRelations" } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityRequestBody" } } } } }, "get": { "x-controller-name": "EntitiesController", "x-operation-name": "find", "tags": [ "Entities" ], "operationId": "getEntities", "responses": { "200": { "description": "Array of entities retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Entities.Filter1" } } } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "includeSystem", "in": "query", "schema": { "type": "boolean" }, "description": "Include Read-Only System Entities" } ] } }, "/v2/identities/invalid/count": { "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "getInvalidIdentitiesCount", "tags": [ "Identities" ], "operationId": "getInvalidIdentitiesCount", "responses": { "200": { "description": "Invalid identities count retrieved successfully", "content": { "application/json": { "schema": { "type": "number" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/identities/invalid": { "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "getInvalidIdentities", "tags": [ "Identities" ], "operationId": "getInvalidIdentities", "responses": { "200": { "description": "Invalid identities retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvalidIdentityWithArchivable" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/identities/kyc-status/bulk": { "post": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "getBulkKycStatus", "tags": [ "Identities" ], "operationId": "getBulkIdentityKycStatus", "responses": { "200": { "description": "Bulk KYC status retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "rollupStatus": { "type": "string", "enum": [ "submitted", "running", "completed", "failed" ] }, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "beneficialOwners": { "type": "array", "items": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "status": { "type": "string", "enum": [ "submitted", "running", "completed", "failed" ] } } } } } } } } } }, "400": { "description": "Invalid request body or identity IDs", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "identityIds": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 500 } }, "required": [ "identityIds" ], "additionalProperties": false } } } } } }, "/v2/identities/{identityId}/create/{relationship}/{childId}": { "post": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "createIdentityRelationship", "tags": [ "Identities" ], "operationId": "createIdentityRelationship", "responses": { "200": { "description": "Identity relationship created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentitiesRelations" } } } }, "400": { "description": "Invalid relationship data or creation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "relationship", "in": "path", "schema": { "type": "string", "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "required": true }, { "name": "childId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIdentityRelationshipRequestBody" } } }, "x-parameter-index": 3 } } }, "/v2/identities/{identityId}/delete/{relationship}/{childId}": { "post": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "deleteIdentityRelationship", "tags": [ "Identities" ], "operationId": "deleteIdentityRelationship", "responses": { "204": { "description": "Attempt to remove Identity relationship" }, "400": { "description": "Invalid relationship or deletion failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Relationship not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "relationship", "in": "path", "schema": { "type": "string", "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "required": true }, { "name": "childId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/v2/identities/{identityId}/files/{id}/download": { "get": { "x-controller-name": "IdentityFilesController", "x-operation-name": "downloadById", "tags": [ "Identities" ], "operationId": "downloadIdentityFileById", "responses": { "200": { "description": "Identity file downloaded successfully", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity file not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity file", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/identities/{identityId}/files/{id}": { "get": { "x-controller-name": "IdentityFilesController", "x-operation-name": "findById", "tags": [ "Identities" ], "operationId": "getIdentityFileById", "responses": { "200": { "description": "Identity file retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityFilesWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity file not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity file", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityFiles.Filter" } } } } ] }, "delete": { "x-controller-name": "IdentityFilesController", "x-operation-name": "deleteById", "tags": [ "Identities" ], "operationId": "deleteIdentityFileById", "responses": { "204": { "description": "Identity file deleted successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity file not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "422": { "description": "Unable to delete file. Please try again", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "name": { "type": "string", "example": "UnprocessableEntityError" }, "message": { "type": "string", "example": "Unable to delete file. Please try again" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity file", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/identities/{identityId}/files": { "post": { "x-controller-name": "IdentityFilesController", "x-operation-name": "create", "tags": [ "Identities" ], "operationId": "uploadIdentityFile", "responses": { "200": { "description": "Identity file uploaded successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityFiles" } } } }, "400": { "description": "Invalid file data or upload failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "fileType": { "type": "string", "enum": [ "w_8", "w_9", "w_8_ben", "w_8_bene", "passport", "driving_license", "national_identity_card", "residence_permit", "passport_card", "tax_id", "visa", "voter_id", "residence_status_document", "postal_identity_card", "social_security_card", "work_permit", "asylum_registration_card", "national_health_insurance_card", "municipality_identity_card", "private_operators_card", "proof_of_citizenship", "service_id_card", "immigration_status_document", "indigenous_card", "vehicle_registration_card", "certificate_of_naturalisation", "professional_qualification_card", "consular_id", "international_driving_licence", "source_of_funds", "wire_instructions", "entity_formation", "bank_building_society_statement", "council_tax", "general_letter", "mobile_phone_bill", "pension_property_statement_letter", "insurance_statement", "exchange_house_statement", "accommodation_tenancy_certificate" ] }, "side": { "type": "string", "nullable": false, "enum": [ "front", "back" ] } } } } } } }, "get": { "x-controller-name": "IdentityFilesController", "x-operation-name": "findByIdentityId", "tags": [ "Identities" ], "operationId": "getIdentityFilesByIdentityId", "responses": { "200": { "description": "Identity files retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityFilesWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityFiles.Filter" } } } } ] } }, "/v2/identities/{identityId}/kyc-status": { "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "getKycStatus", "tags": [ "Identities" ], "operationId": "getIdentityKycStatus", "responses": { "200": { "description": "KYC status retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "rollupStatus": { "type": "string", "enum": [ "submitted", "running", "completed", "failed" ] }, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "beneficialOwners": { "type": "array", "items": { "type": "object", "properties": { "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "status": { "type": "string", "enum": [ "submitted", "running", "completed", "failed" ] } } } } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/identities/{id}/validate/{action}": { "post": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "validateIdentityForActionWithContext", "tags": [ "Identities" ], "operationId": "validateIdentityByIdForActionWithContext", "responses": { "200": { "description": "Identity validation action completed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "_tag": { "type": "string" }, "context": { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "RELATIONSHIP", "DATA", "FILE" ] }, "reference": { "type": "string", "enum": [ "BENEFICIAL OWNER", "SIGNER" ] }, "errorType": { "type": "string", "enum": [ "INVALID", "MISSING" ] } } }, "references": { "type": "array", "items": { "type": "object", "properties": { "targetId": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "_tag": { "type": "string" }, "context": { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "RELATIONSHIP", "DATA", "FILE" ] }, "reference": { "type": "string", "enum": [ "BENEFICIAL OWNER", "SIGNER" ] }, "errorType": { "type": "string", "enum": [ "INVALID", "MISSING" ] } } } } } } } } } } } } } } } } }, "400": { "description": "Invalid action or validation failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "action", "in": "path", "schema": { "type": "string", "enum": [ "FUND_MANAGER", "PARTNERSHIP_REPRESENTATIVE", "INVESTOR", "BANK_ACCOUNT_APPLICATION", "KYC_CHECK" ] }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "LAYER2" ] }, "controlPersonId": { "type": "string", "format": "uuid" } } } ] } } }, "x-parameter-index": 2 } }, "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "validateIdentityForAction", "tags": [ "Identities" ], "operationId": "validateIdentityByIdForAction", "responses": { "200": { "description": "Identity validation action retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "_tag": { "type": "string" }, "context": { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "RELATIONSHIP", "DATA", "FILE" ] }, "reference": { "type": "string", "enum": [ "BENEFICIAL OWNER", "SIGNER" ] }, "errorType": { "type": "string", "enum": [ "INVALID", "MISSING" ] } } }, "references": { "type": "array", "items": { "type": "object", "properties": { "targetId": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "_tag": { "type": "string" }, "context": { "type": "object", "properties": { "dataType": { "type": "string", "enum": [ "RELATIONSHIP", "DATA", "FILE" ] }, "reference": { "type": "string", "enum": [ "BENEFICIAL OWNER", "SIGNER" ] }, "errorType": { "type": "string", "enum": [ "INVALID", "MISSING" ] } } } } } } } } } } } } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "action", "in": "path", "schema": { "type": "string", "enum": [ "FUND_MANAGER", "PARTNERSHIP_REPRESENTATIVE", "INVESTOR", "BANK_ACCOUNT_APPLICATION", "KYC_CHECK" ] }, "required": true } ] } }, "/v2/identities/{id}/validate": { "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "validateIdentity", "tags": [ "Identities" ], "operationId": "validateIdentityById", "responses": { "200": { "description": "Identity validation retrieved successfully", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/identities/{identityId}/{relationship}/{childId}": { "patch": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "updateIdentityRelationship", "tags": [ "Identities" ], "operationId": "updateIdentityRelationship", "responses": { "204": { "description": "Identity relationship updated successfully" }, "400": { "description": "Invalid relationship data or update failed", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Relationship not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "relationship", "in": "path", "schema": { "type": "string", "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "description": "Type of identity relationship", "required": true }, { "name": "childId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ownershipPercentage": { "type": "number" } }, "required": [ "ownershipPercentage" ], "additionalProperties": false } } }, "x-parameter-index": 3 } } }, "/v2/identities/{identityId}/{relationship}": { "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "getIdentityRelation", "tags": [ "Identities" ], "operationId": "getIdentityRelation", "responses": { "200": { "description": "Identity relationships retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentitiesRelationsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "identityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "relationship", "in": "path", "schema": { "type": "string", "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "required": true } ] } }, "/v2/identities/{id}": { "patch": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "updateById", "tags": [ "Identities" ], "operationId": "updateIdentity", "responses": { "200": { "description": "Identity updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identities" } } } }, "400": { "description": "Invalid identity data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIdentityRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "findById", "tags": [ "Identities" ], "operationId": "getIdentityById", "responses": { "200": { "description": "Identity retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdentityWithArchivableDtoWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Identity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the identity", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identities.Filter" } } } } ] } }, "/v2/identities": { "post": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "create", "tags": [ "Identities" ], "operationId": "createIdentity", "responses": { "200": { "description": "Identity created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identities" } } } }, "400": { "description": "Invalid identity data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIdentityRequestBody" } } } } }, "get": { "x-controller-name": "IdentitiesV2Controller", "x-operation-name": "find", "tags": [ "Identities" ], "operationId": "getIdentities", "responses": { "200": { "description": "Array of identities retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityWithArchivableDtoWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Identities.Filter1" } } } } ] } }, "/v2/notifications/count": { "get": { "x-controller-name": "NotificationsController", "x-operation-name": "getNotificationsCount", "tags": [ "Notifications" ], "operationId": "getNotificationsCount", "responses": { "200": { "description": "Notification count retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "read": { "type": "number", "description": "Number of read notifications" }, "unread": { "type": "number", "description": "Number of unread notifications" } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/notifications/notify/k1-available/{entityId}/{taxYear}": { "post": { "x-controller-name": "NotificationsController", "x-operation-name": "notifyEntityLpsK1", "tags": [ "Notifications" ], "operationId": "notifyLPsK1Available", "responses": { "200": { "description": "K-1 notification sent successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "Email address of notification recipient" } } } } }, "400": { "description": "Invalid entity or tax year data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "entityId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "taxYear", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "previewRecipients", "in": "query", "schema": { "type": "boolean" } } ] } }, "/v2/notifications/notify/k1-available/{taxYear}": { "post": { "x-controller-name": "NotificationsController", "x-operation-name": "notifyEntityLpsK1AllEntities", "tags": [ "Notifications" ], "operationId": "notifyLPsK1AvailableBulk", "responses": { "200": { "description": "Bulk K-1 notifications sent successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "notification": { "$ref": "#/components/schemas/Notifications" }, "users": { "type": "array", "items": { "type": "string" }, "description": "User IDs who received the notification" }, "emails": { "type": "array", "items": { "type": "string" }, "description": "Email addresses of notification recipients" }, "actions": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } }, "description": "Action button configuration" } } } } } } }, "400": { "description": "Invalid tax year or entity data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "taxYear", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "previewRecipients", "in": "query", "schema": { "type": "boolean" } } ] } }, "/v2/notifications/read": { "patch": { "x-controller-name": "NotificationsController", "x-operation-name": "markAllNotificationsAsRead", "tags": [ "Notifications" ], "operationId": "markAllNotificationsRead", "responses": { "204": { "description": "All notifications marked as read successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/notifications/settings/{type}/{enabled}": { "post": { "x-controller-name": "NotificationsController", "x-operation-name": "setNotificationSettingsByType", "tags": [ "Notifications" ], "operationId": "setNotificationSettingByType", "responses": { "200": { "description": "Notification setting updated successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether email notifications are enabled" } } } } } } } }, "400": { "description": "Invalid notification type or enabled value", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Notification settings not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "type", "in": "path", "schema": { "enum": [ "EMAIL" ], "type": "string" }, "required": true }, { "name": "enabled", "in": "path", "schema": { "type": "boolean" }, "required": true } ] } }, "/v2/notifications/settings": { "get": { "x-controller-name": "NotificationsController", "x-operation-name": "getNotificationSettings", "tags": [ "Notifications" ], "operationId": "getNotificationSettings", "responses": { "200": { "description": "Notification settings retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Whether email notifications are enabled" } } } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Notification settings not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/notifications/{id}/read": { "patch": { "x-controller-name": "NotificationsController", "x-operation-name": "markNotificationAsRead", "tags": [ "Notifications" ], "operationId": "markNotificationAsRead", "responses": { "204": { "description": "Notification marked as read successfully" }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Notification not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the notification", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ] } }, "/v2/notifications": { "get": { "x-controller-name": "NotificationsController", "x-operation-name": "getNotifications", "tags": [ "Notifications" ], "operationId": "getNotifications", "responses": { "200": { "description": "Notifications retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ListingNotification" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationUsers.Filter" } } } } ] } }, "/v2/organizations/count": { "get": { "x-controller-name": "OrganizationsController", "x-operation-name": "count", "tags": [ "Organizations" ], "operationId": "getOrganizationsCount", "responses": { "200": { "description": "Organization count retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Organizations.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ] } }, "/v2/organizations/{id}": { "patch": { "x-controller-name": "OrganizationsController", "x-operation-name": "updateById", "tags": [ "Organizations" ], "operationId": "updateOrganizationById", "responses": { "204": { "description": "Organization updated successfully" }, "400": { "description": "Invalid organization data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the organization", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationRequestBody" } } }, "x-parameter-index": 1 } }, "get": { "x-controller-name": "OrganizationsController", "x-operation-name": "findById", "tags": [ "Organizations" ], "operationId": "getOrganizationById", "responses": { "200": { "description": "Organization retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationsWithRelations" } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the organization", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations.Filter" } } } } ] } }, "/v2/organizations": { "post": { "x-controller-name": "OrganizationsController", "x-operation-name": "create", "tags": [ "Organizations" ], "operationId": "createOrganization", "responses": { "200": { "description": "Organization created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations" } } } }, "400": { "description": "Invalid organization data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequestBody" } } } } }, "get": { "x-controller-name": "OrganizationsController", "x-operation-name": "find", "tags": [ "Organizations" ], "operationId": "getOrganizations", "responses": { "200": { "description": "Organizations retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationsWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organizations.Filter1" } } } } ] } }, "/v2/taxes/entities/{taxYear}/incomplete-count": { "get": { "x-controller-name": "TaxesV2Controller", "x-operation-name": "outstandingTaxFilings", "tags": [ "Taxes" ], "operationId": "getIncompleteTaxesCountByYear", "responses": { "200": { "description": "Incomplete taxes count retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } }, "400": { "description": "Invalid tax year parameter", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "x-visibility": "documented", "parameters": [ { "name": "taxYear", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/v2/taxes/entities/{entityId}/ledger": { "post": { "x-controller-name": "TaxesV2Controller", "x-operation-name": "create", "tags": [ "Taxes" ], "operationId": "createEntityLedgerEntry", "responses": { "200": { "description": "Ledger entry created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ledger" } } } }, "400": { "description": "Invalid ledger data or entity ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "x-visibility": "documented", "parameters": [ { "name": "entityId", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLedger" } } } } } }, "/v2/taxes/investment-taxes/{taxYear}": { "get": { "x-controller-name": "TaxesV2Controller", "x-operation-name": "getInvestmentTaxes", "tags": [ "Taxes" ], "operationId": "getInvestmentTaxes", "responses": { "200": { "description": "Investment tax records retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentTax" } } } } }, "400": { "description": "Invalid tax year or search parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "taxYear", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvestmentsTaxes.Filter" } } } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ] } }, "/v2/tickets/{type}": { "post": { "x-controller-name": "TicketsController", "x-operation-name": "createTicket", "tags": [ "Support Tickets" ], "operationId": "createTicket", "responses": { "200": { "description": "Support ticket created successfully", "content": { "application/json": { "schema": { "type": "object", "description": "Created ticket information from Intercom", "properties": { "ticket": { "type": "object", "description": "Created ticket details", "properties": { "id": { "type": "string", "description": "Ticket ID" }, "ticket_type_id": { "type": "string", "description": "Type of ticket" }, "state": { "type": "string", "description": "Current state of the ticket" }, "created_at": { "type": "number", "description": "Ticket creation timestamp" } } } } } } } }, "400": { "description": "Invalid ticket type or request data", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string", "enum": [ "Tax" ] }, "description": "Type of support ticket to create", "example": "Tax", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "entityId", "message" ], "properties": { "entityId": { "type": "string", "description": "ID of the entity related to the ticket", "example": "123e4567-e89b-12d3-a456-426614174000" }, "message": { "type": "string", "description": "Description of the issue or support request", "example": "Need help with tax calculation for Q4 2023" } } } } }, "x-parameter-index": 1 } } }, "/v2/tickets": { "get": { "x-controller-name": "TicketsController", "x-operation-name": "getTickets", "tags": [ "Support Tickets" ], "operationId": "getTickets", "responses": { "200": { "description": "User support tickets retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "description": "Support ticket information from Intercom", "properties": { "id": { "type": "string", "description": "Ticket ID" }, "ticket_type_id": { "type": "string", "description": "Type of ticket" }, "state": { "type": "string", "description": "Current state of the ticket" }, "created_at": { "type": "number", "description": "Ticket creation timestamp" } } } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } } } }, "/v2/xero/authorize": { "get": { "x-controller-name": "XeroAuthController", "x-operation-name": "authorize", "tags": [ "XeroAuthController" ], "operationId": "authorizeXero", "responses": { "200": { "description": "Authorization URL for Xero OAuth flow", "content": { "application/json": { "schema": { "type": "object", "properties": { "authorizationUrl": { "type": "string", "description": "URL to redirect user to for Xero authorization" }, "state": { "type": "string", "description": "State parameter for CSRF protection (stored server-side)" } } } } } }, "500": { "description": "Failed to generate authorization URL" } } } }, "/v2/xero/callback": { "get": { "x-controller-name": "XeroAuthController", "x-operation-name": "callback", "tags": [ "XeroAuthController" ], "operationId": "xeroCallback", "responses": { "200": { "description": "Successfully connected to Xero", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } }, "400": { "description": "Invalid callback parameters" }, "500": { "description": "Failed to complete OAuth flow" } }, "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" }, "description": "Authorization code from Xero", "required": true }, { "name": "state", "in": "query", "schema": { "type": "string" }, "description": "State parameter for CSRF protection", "required": true }, { "name": "error", "in": "query", "schema": { "type": "string" }, "description": "Error code if authorization failed", "required": false } ] } }, "/v2/xero/disconnect": { "get": { "x-controller-name": "XeroAuthController", "x-operation-name": "disconnect", "tags": [ "XeroAuthController" ], "operationId": "disconnectXero", "responses": { "200": { "description": "Successfully disconnected from Xero", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } } } }, "/v2/xero/invoices/count": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "count", "tags": [ "XeroInvoicesController" ], "operationId": "getXeroInvoicesCount", "responses": { "200": { "description": "Invoices count", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ] } }, "/v2/xero/invoices/debug/sample": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "debugSample", "tags": [ "XeroInvoicesController" ], "operationId": "debugXeroInvoiceSample", "responses": { "200": { "description": "Sample raw invoice from Xero for debugging", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } } ] } }, "/v2/xero/invoices/errors": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "getErrors", "tags": [ "XeroInvoicesController" ], "operationId": "getXeroInvoiceErrors", "responses": { "200": { "description": "Invoices that failed to sync", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "number" } } ] } }, "/v2/xero/invoices/fetch/{xeroInvoiceId}": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "fetchById", "tags": [ "XeroInvoicesController" ], "operationId": "fetchXeroInvoiceById", "responses": { "200": { "description": "Invoice data from Xero", "content": { "application/json": { "schema": { "type": "object", "description": "Raw invoice data from Xero API" } } } }, "500": { "description": "Failed to fetch invoice" } }, "parameters": [ { "name": "xeroInvoiceId", "in": "path", "schema": { "type": "string" }, "required": true } ] } }, "/v2/xero/invoices/sync": { "post": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "sync", "tags": [ "XeroInvoicesController" ], "operationId": "syncXeroInvoices", "responses": { "200": { "description": "Job queued successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "jobId": { "type": "string" }, "message": { "type": "string" } } } } } }, "500": { "description": "Failed to queue job" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dealId": { "type": "string", "format": "uuid", "description": "Optional deal ID to associate invoices with" }, "entityId": { "type": "string", "format": "uuid", "description": "Optional entity ID to associate invoices with" }, "fullSync": { "type": "boolean", "description": "If true, syncs all invoices. If false, only syncs invoices modified since last sync", "default": false } } } } } } } }, "/v2/xero/invoices/{id}": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "findById", "tags": [ "XeroInvoicesController" ], "operationId": "getXeroInvoiceById", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices.Filter" } } } } ] } }, "/v2/xero/invoices": { "get": { "x-controller-name": "XeroInvoicesController", "x-operation-name": "find", "tags": [ "XeroInvoicesController" ], "operationId": "getXeroInvoices", "responses": { "200": { "description": "Array of Invoices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices.Filter1" } } } } ] } }, "/v2/xero/refresh": { "get": { "x-controller-name": "XeroAuthController", "x-operation-name": "refresh", "tags": [ "XeroAuthController" ], "operationId": "refreshXeroToken", "responses": { "200": { "description": "Successfully refreshed Xero token", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } }, "400": { "description": "No refresh token available" }, "500": { "description": "Failed to refresh token" } } } }, "/v2/xero/status": { "get": { "x-controller-name": "XeroAuthController", "x-operation-name": "getStatus", "tags": [ "XeroAuthController" ], "operationId": "getXeroStatus", "responses": { "200": { "description": "Xero connection status", "content": { "application/json": { "schema": { "type": "object", "properties": { "connected": { "type": "boolean" }, "hasCredentials": { "type": "boolean" }, "expiresAt": { "type": "string", "format": "date-time", "nullable": true } } } } } } } } }, "/{dealId}/transfer-requests": { "post": { "x-controller-name": "TransferRequestController", "x-operation-name": "create", "tags": [ "Transfer Requests" ], "operationId": "createTransferRequest", "responses": { "200": { "description": "TransferRequest created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequestWithRelations" } } } }, "400": { "description": "Bad request - invalid parameters", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "name": { "type": "string", "example": "BadRequestError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTransferRequest" } } } } }, "get": { "x-controller-name": "TransferRequestController", "x-operation-name": "findByDeal", "tags": [ "Transfer Requests" ], "operationId": "getTransferRequestsByDealId", "responses": { "200": { "description": "Array of TransferRequest model instances for the deal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferRequestWithRelations" } } } } }, "401": { "description": "Authentication error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "name": { "type": "string", "example": "UnauthorizedError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "404": { "description": "Deal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 404 }, "name": { "type": "string", "example": "NotFoundError" }, "message": { "type": "string", "example": "message" } }, "required": [ "statusCode", "name", "message" ] } }, "required": [ "error" ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 500 }, "message": { "type": "string", "example": "Internal Server Error" } }, "required": [ "statusCode", "message" ] } }, "required": [ "error" ] } } } } }, "parameters": [ { "name": "dealId", "in": "path", "schema": { "type": "string" }, "description": "Unique identifier of the deal", "example": "123e4567-e89b-12d3-a456-426614174000", "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferRequest.Filter1" } } } } ] } } }, "components": { "schemas": { "DealsWithRelations": { "title": "DealsWithRelations", "type": "object", "description": "(tsType: DealsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "minimumInvestment": { "type": "number", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "offeringType": { "type": "string", "nullable": true }, "managementFeeFrequency": { "type": "string", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "targetRaiseGoal": { "type": "number", "nullable": true }, "totalCarry": { "type": "number", "nullable": true }, "slug": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "documentsTemplateId": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "shortcodeId": { "type": "string", "nullable": true }, "totalCarryNotes": { "type": "string", "nullable": true }, "managementFeeNotes": { "type": "string", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "string", "nullable": true }, "migrationApproval": { "type": "boolean", "nullable": true }, "migrationApprovalDate": { "type": "string", "nullable": true }, "migrationApprovalEmail": { "type": "string", "nullable": true }, "migrationFmSent": { "type": "boolean", "nullable": true }, "invoiceAmount": { "type": "number", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceStatus": { "type": "string", "nullable": true }, "capitalAccountStatementURI": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time", "nullable": true }, "advisorStatus": { "type": "string", "nullable": true }, "entityId": { "type": "string" }, "fmIdentityId": { "type": "string" }, "advisorId": { "type": "string", "nullable": true }, "organizationId": { "type": "string" }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "foreignKey": {}, "fmIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "advisorIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "closes": { "type": "array", "items": { "$ref": "#/components/schemas/ClosesWithRelations" } }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } }, "invitations": { "type": "array", "items": { "$ref": "#/components/schemas/InvitationsWithRelations" } }, "dealDetails": { "$ref": "#/components/schemas/DealDetailsWithRelations" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FilesWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "DealsWithRelations" }, "EntitiesWithRelations": { "title": "EntitiesWithRelations", "type": "object", "description": "(tsType: EntitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "formationDate": { "type": "string", "format": "date-time", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "fundManager": { "type": "string", "nullable": true }, "taxStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "returnId": { "type": "string", "nullable": true }, "taxesProvider": { "type": "string", "nullable": true }, "taxesProviderId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "partnershipRepresentativeId": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualId": { "type": "string", "nullable": true }, "parentEntityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "deals": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } }, "entitiesTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesTaxesWithRelations" } }, "investmentsTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTaxesWithRelations" } }, "legacyLedgers": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerWithRelations" } }, "ledger": { "$ref": "#/components/schemas/LedgersWithRelations" }, "partnershipRepresentative": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "partnershipRepresentativeDesignatedIndividual": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "parentEntity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "entitiesTaxesMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesTaxesMetadataWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "EntitiesWithRelations" }, "OrganizationsWithRelations": { "title": "OrganizationsWithRelations", "type": "object", "description": "(tsType: OrganizationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true }, "mongoId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "highVolumePartner": { "type": "boolean", "nullable": true }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "string", "nullable": true }, "mouSigned": { "type": "boolean", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "phase": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "tags": { "type": "string", "nullable": true }, "representativeIdentityId": { "type": "string", "nullable": true }, "representativeIndividualIdentityId": { "type": "string", "nullable": true }, "deals": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationsRolesWithRelations" } }, "representativeIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "representativeIndividualIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "OrganizationsWithRelations" }, "InvoiceLineItemsWithRelations": { "title": "InvoiceLineItemsWithRelations", "type": "object", "description": "(tsType: InvoiceLineItemsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "lineItemId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": false }, "quantity": { "type": "number", "nullable": false }, "unitAmount": { "type": "number", "nullable": false }, "lineAmount": { "type": "number", "nullable": false }, "accountCode": { "type": "string", "nullable": true }, "accountId": { "type": "string", "nullable": true }, "taxType": { "type": "string", "nullable": true }, "taxAmount": { "type": "number", "nullable": true }, "itemCode": { "type": "string", "nullable": true }, "discountRate": { "type": "number", "nullable": true }, "discountAmount": { "type": "number", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "providerData": { "type": "object", "nullable": true }, "lastSuccessfulSync": { "type": "string", "format": "date-time", "nullable": true }, "syncStatus": { "type": "string", "nullable": true }, "invoiceId": { "type": "string", "nullable": false }, "invoice": { "$ref": "#/components/schemas/InvoicesWithRelations" }, "foreignKey": {} }, "required": [ "description", "quantity", "unitAmount", "lineAmount", "invoiceId" ], "additionalProperties": false, "x-typescript-type": "InvoiceLineItemsWithRelations" }, "InvoicesWithRelations": { "title": "InvoicesWithRelations", "type": "object", "description": "(tsType: InvoicesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "type": { "type": "string", "nullable": false }, "invoiceNumber": { "type": "string", "nullable": false }, "reference": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false }, "date": { "type": "string", "format": "date-time", "nullable": false }, "dueDate": { "type": "string", "format": "date-time", "nullable": true }, "expectedPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "plannedPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "subTotal": { "type": "number", "nullable": false }, "totalTax": { "type": "number", "nullable": false }, "total": { "type": "number", "nullable": false }, "totalDiscount": { "type": "number", "nullable": true }, "amountDue": { "type": "number", "nullable": false }, "amountPaid": { "type": "number", "nullable": false }, "amountCredited": { "type": "number", "nullable": false }, "currencyCode": { "type": "string", "nullable": false }, "currencyRate": { "type": "number", "nullable": true }, "contactName": { "type": "string", "nullable": false }, "contactId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "providerData": { "type": "object", "nullable": true }, "lastSuccessfulSync": { "type": "string", "format": "date-time", "nullable": true }, "syncStatus": { "type": "string", "nullable": true }, "dealId": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "sentToContact": { "type": "boolean", "nullable": true }, "url": { "type": "string", "nullable": true }, "lineAmountTypes": { "type": "string", "nullable": false }, "brandingThemeId": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLineItemsWithRelations" } } }, "required": [ "type", "invoiceNumber", "status", "date", "subTotal", "totalTax", "total", "amountDue", "amountPaid", "amountCredited", "currencyCode", "contactName", "lineAmountTypes" ], "additionalProperties": false, "x-typescript-type": "InvoicesWithRelations" }, "TransferInformationWithRelations": { "title": "TransferInformationWithRelations", "type": "object", "description": "(tsType: TransferInformationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "accountId": { "type": "string", "nullable": false }, "routingNumber": { "type": "string", "nullable": false }, "assetType": { "type": "string", "nullable": false, "enum": [ "USD", "USDC", "USDT", "Broker" ] }, "method": { "type": "string", "nullable": false, "enum": [ "ACH", "WIRE", "SWIFT", "CRYPTO", "BROKER" ] }, "bankName": { "type": "string", "nullable": false }, "bankAddress": { "type": "string", "nullable": true }, "bankAccountType": { "type": "string", "nullable": false, "enum": [ "Domestic", "International", "Broker" ] }, "beneficiaryName": { "type": "string", "nullable": false }, "beneficiaryAddress": { "type": "string", "nullable": true }, "beneficiaryPhoneNumber": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "brokerageFirmName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "dtcParticipantNumber": { "type": "string", "nullable": true }, "additionalAccountInformation": { "type": "string", "nullable": true }, "identityId": { "type": "string" }, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {} }, "required": [ "accountId", "assetType", "method", "bankAccountType", "beneficiaryName", "identityId" ], "additionalProperties": false, "x-typescript-type": "TransferInformationWithRelations" }, "UsersWithRelations": { "title": "UsersWithRelations", "type": "object", "description": "(tsType: UsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "mongoId": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "isSuperAdmin": { "type": "boolean", "nullable": false, "default": false }, "isMigration": { "type": "boolean", "nullable": true }, "birthdate": { "type": "string", "format": "date-time", "nullable": true }, "citizenshipCountry": { "type": "string", "nullable": true }, "taxId": { "type": "string", "nullable": true } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "UsersWithRelations" }, "TransferRequestWithRelations": { "title": "TransferRequestWithRelations", "type": "object", "description": "(tsType: TransferRequestWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "recipientId": { "type": "string" }, "status": { "type": "string" }, "requestedAmount": { "type": "number" }, "sentAmount": { "type": "number" }, "declaredPurpose": { "type": "string" }, "recipientData": { "type": "object" }, "userId": { "type": "string" }, "dealId": { "type": "string" }, "entityId": { "type": "string" }, "recipient": { "$ref": "#/components/schemas/TransferInformationWithRelations" }, "foreignKey": {}, "requestedBy": { "$ref": "#/components/schemas/UsersWithRelations" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "required": [ "status", "requestedAmount" ], "additionalProperties": false, "x-typescript-type": "TransferRequestWithRelations" }, "NewTransferRequest": { "title": "NewTransferRequest", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransferRequest', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "recipientId": { "type": "string" }, "status": { "type": "string" }, "requestedAmount": { "type": "number" }, "sentAmount": { "type": "number" }, "declaredPurpose": { "type": "string" }, "recipientData": { "type": "object" }, "userId": { "type": "string" }, "dealId": { "type": "string" }, "entityId": { "type": "string" } }, "required": [ "status", "requestedAmount" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "TransferRequestPartial": { "title": "TransferRequestPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "recipientId": { "type": "string" }, "status": { "type": "string" }, "requestedAmount": { "type": "number" }, "sentAmount": { "type": "number" }, "declaredPurpose": { "type": "string" }, "recipientData": { "type": "object" }, "userId": { "type": "string" }, "dealId": { "type": "string" }, "entityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "TransferRequest": { "title": "TransferRequest", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "recipientId": { "type": "string" }, "status": { "type": "string" }, "requestedAmount": { "type": "number" }, "sentAmount": { "type": "number" }, "declaredPurpose": { "type": "string" }, "recipientData": { "type": "object" }, "userId": { "type": "string" }, "dealId": { "type": "string" }, "entityId": { "type": "string" } }, "required": [ "status", "requestedAmount" ], "additionalProperties": false }, "BulkUpdateTransferRequestDto": { "title": "BulkUpdateTransferRequestDto", "type": "object", "description": "(tsType: BulkUpdateTransferRequestDto, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false, "format": "uuid" }, "status": { "type": "string", "nullable": false, "enum": [ "pending", "approved", "completed", "rejected" ] }, "sentAmount": { "type": "number", "nullable": true, "minimum": 0 }, "declaredPurpose": { "type": "string", "nullable": true }, "recipientData": { "type": "object", "nullable": true } }, "required": [ "id" ], "additionalProperties": false, "x-typescript-type": "BulkUpdateTransferRequestDto" }, "NewTransferInformation": { "title": "NewTransferInformation", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTransferInformation', exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "accountId": { "type": "string", "nullable": false }, "routingNumber": { "type": "string", "nullable": false }, "assetType": { "type": "string", "nullable": false, "enum": [ "USD", "USDC", "USDT", "Broker" ] }, "method": { "type": "string", "nullable": false, "enum": [ "ACH", "WIRE", "SWIFT", "CRYPTO", "BROKER" ] }, "bankName": { "type": "string", "nullable": false }, "bankAddress": { "type": "string", "nullable": true }, "bankAccountType": { "type": "string", "nullable": false, "enum": [ "Domestic", "International", "Broker" ] }, "beneficiaryName": { "type": "string", "nullable": false }, "beneficiaryAddress": { "type": "string", "nullable": true }, "beneficiaryPhoneNumber": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "brokerageFirmName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "dtcParticipantNumber": { "type": "string", "nullable": true }, "additionalAccountInformation": { "type": "string", "nullable": true }, "identityId": { "type": "string" } }, "required": [ "accountId", "assetType", "method", "bankAccountType", "beneficiaryName", "identityId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "AdminNotificationsService": {}, "TransferInformationPartialExcluding_id-createdAt-updatedAt-deleted-deletedOn-deletedBy_": { "title": "TransferInformationPartialExcluding_id-createdAt-updatedAt-deleted-deletedOn-deletedBy_", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>, schemaOptions: { partial: true, exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "accountId": { "type": "string", "nullable": false }, "routingNumber": { "type": "string", "nullable": false }, "assetType": { "type": "string", "nullable": false, "enum": [ "USD", "USDC", "USDT", "Broker" ] }, "method": { "type": "string", "nullable": false, "enum": [ "ACH", "WIRE", "SWIFT", "CRYPTO", "BROKER" ] }, "bankName": { "type": "string", "nullable": false }, "bankAddress": { "type": "string", "nullable": true }, "bankAccountType": { "type": "string", "nullable": false, "enum": [ "Domestic", "International", "Broker" ] }, "beneficiaryName": { "type": "string", "nullable": false }, "beneficiaryAddress": { "type": "string", "nullable": true }, "beneficiaryPhoneNumber": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "brokerageFirmName": { "type": "string", "nullable": true }, "accountType": { "type": "string", "nullable": true }, "dtcParticipantNumber": { "type": "string", "nullable": true }, "additionalAccountInformation": { "type": "string", "nullable": true }, "identityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>" }, "EntitiesRepository": {}, "TaxRecordsBundle": { "title": "TaxRecordsBundle", "type": "object", "description": "(tsType: TaxRecordsBundleDto, schemaOptions: { title: 'TaxRecordsBundle' })", "properties": { "entityTaxRecord": { "type": "object" }, "investmentTaxRecords": { "type": "array", "items": { "type": "object" } }, "sourceData": { "type": "object" }, "snapshot1065Data": { "type": "object" }, "confidenceReport": { "type": "object" } }, "required": [ "entityTaxRecord", "investmentTaxRecords", "confidenceReport" ], "additionalProperties": false, "x-typescript-type": "TaxRecordsBundleDto" }, "TaxesDataManagerService": {}, "TaxCalculatorService": {}, "EntitiesTaxesRepository": {}, "PdfFillService": {}, "Ledger": { "title": "Ledger", "type": "object", "description": "(tsType: LedgersWithRelations, schemaOptions: { title: 'Ledger', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userId": { "type": "string", "nullable": false }, "organizationId": { "type": "string", "nullable": false }, "entityId": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/UsersWithRelations" }, "foreignKey": {}, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "LedgersWithRelations" }, "NewLedger": { "title": "NewLedger", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewLedger', exclude: [ 'id', 'createdAt', 'updatedAt' ] })", "properties": { "amount": { "type": "number", "nullable": false }, "debit": { "type": "boolean", "nullable": false }, "categoriesId": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true }, "entryDate": { "type": "string", "nullable": false }, "newLedgerEntryId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "TaxesMetadataService": {}, "InvestmentsWithRelations": { "title": "InvestmentsWithRelations", "type": "object", "description": "(tsType: InvestmentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "blueskyFees": { "type": "number", "nullable": true }, "capitalWiredAmount": { "type": "number" }, "carry": { "type": "number", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "managementFeesDollars": { "type": "number", "nullable": true }, "netInvestment": { "type": "number", "nullable": true }, "otherExpenses": { "type": "number", "nullable": true }, "privateFundExpenses": { "type": "number", "nullable": true }, "spvFees": { "type": "number", "nullable": true }, "subscriptionAmount": { "type": "number", "nullable": true }, "completeAt": { "type": "string", "format": "date-time", "nullable": true }, "ledgerMatched": { "type": "boolean", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoInvestmentId": { "type": "string", "nullable": true }, "mongoUserId": { "type": "string", "nullable": true }, "invitedAtLegacy": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "manualEntryWireDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true }, "invitedAt": { "type": "string", "format": "date-time", "nullable": true }, "wiredDate": { "type": "string", "format": "date-time", "nullable": true }, "distributionAssetType": { "type": "string", "nullable": true, "enum": [ "Cash", "Stock", "USDT", "USDC" ] }, "distributionTransferInfoId": { "type": "string", "format": "uuid" }, "identitiesId": { "type": "string" }, "dealId": { "type": "string" }, "userId": { "type": "string" }, "distributionTransferInformation": { "$ref": "#/components/schemas/TransferInformationWithRelations" }, "foreignKey": {}, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "investmentsTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTaxesWithRelations" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FilesWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTransferInformationWithRelations" } } }, "required": [ "userId" ], "additionalProperties": false, "x-typescript-type": "InvestmentsWithRelations" }, "InvestmentTax": { "title": "InvestmentTax", "type": "object", "description": "(tsType: InvestmentsTaxesWithRelations, schemaOptions: { title: 'InvestmentTax', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": true }, "taxYear": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "investorIdentitiesId": { "type": "string", "nullable": true }, "investorLegalName": { "type": "string", "nullable": true }, "investorTaxId": { "type": "string", "nullable": true }, "investorStreetAddress": { "type": "string", "nullable": true }, "investorCity": { "type": "string", "nullable": true }, "investorState": { "type": "string", "nullable": true }, "investorPostalCode": { "type": "string", "nullable": true }, "investorIsUsDomestic": { "type": "boolean", "nullable": true }, "investorFcAndSoiAndDApplicable": { "type": "boolean", "nullable": true }, "investorOtherDeductions": { "type": "number", "nullable": true }, "investorContributions": { "type": "number", "default": 0 }, "investorDistributions": { "type": "number", "nullable": true }, "dealId": { "type": "string", "nullable": true }, "investorEntityType": { "type": "string", "nullable": true }, "investorEntityIsDisregarded": { "type": "boolean", "default": false }, "investorDisregardedOwnerName": { "type": "string", "nullable": true }, "investorDisregardedOwnerTaxId": { "type": "string", "nullable": true }, "investorBeginningProfitPercentage": { "type": "number", "default": 0 }, "investorBeginningLossPercentage": { "type": "number", "default": 0 }, "investorBeginningCapitalPercentage": { "type": "number", "default": 0 }, "investorForeignTaxCreditLimitationApplicable": { "type": "boolean", "nullable": true, "default": false }, "investorCountry": { "type": "string", "nullable": true }, "investorEndingProfitPercentage": { "type": "number", "default": 0 }, "investorEndingLossPercentage": { "type": "number", "default": 0 }, "investorEndingCapitalPercentage": { "type": "number", "default": 0 }, "k1FilesId": { "type": "string", "nullable": true }, "investorOwnershipPercent": { "type": "number", "default": 0 }, "investorCurrentYearNetIncomeLoss": { "type": "number", "default": 0 }, "investorEndingCapitalAccountAmount": { "type": "number", "default": 0 }, "investorBeginningCapitalAccountAmount": { "type": "number", "default": 0 }, "legacyRecordId": { "type": "string", "nullable": true }, "calculatorVersion": { "type": "string", "nullable": true }, "partnerIndex": { "type": "number", "nullable": true }, "investorEmail": { "type": "string", "nullable": true }, "lastPrintedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "investmentId": { "type": "string" }, "entityId": { "type": "string" }, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "foreignKey": {}, "entities": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InvestmentsTaxesWithRelations" }, "SellOrderRequestsWithRelations": { "title": "SellOrderRequestsWithRelations", "type": "object", "description": "(tsType: SellOrderRequestsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "investmentId": { "type": "string" }, "userId": { "type": "string" }, "amount": { "type": "number" }, "notes": { "type": "string" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "SellOrderRequestsWithRelations" }, "NewSellOrderRequests": { "title": "NewSellOrderRequests", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewSellOrderRequests', exclude: [ 'id', 'dealId', 'userId' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "investmentId": { "type": "string" }, "amount": { "type": "number" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "SecondaryRequestsWithRelations": { "title": "SecondaryRequestsWithRelations", "type": "object", "description": "(tsType: SecondaryRequestsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "userId": { "type": "string" }, "amount": { "type": "number" }, "notes": { "type": "string" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "SecondaryRequestsWithRelations" }, "NewSecondaryRequests": { "title": "NewSecondaryRequests", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewSecondaryRequests', exclude: [ 'id', 'dealId', 'userId' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "amount": { "type": "number" }, "notes": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "Context": {}, "ProviderCredentialsRepository": {}, "Organizations": { "title": "Organizations", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true }, "mongoId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "highVolumePartner": { "type": "boolean", "nullable": true }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "string", "nullable": true }, "mouSigned": { "type": "boolean", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "phase": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "tags": { "type": "string", "nullable": true }, "representativeIdentityId": { "type": "string", "nullable": true }, "representativeIndividualIdentityId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateOrganizationRequestBody": { "title": "CreateOrganizationRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateOrganizationRequestBody', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true }, "mongoId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "highVolumePartner": { "type": "boolean", "nullable": true }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "string", "nullable": true }, "mouSigned": { "type": "boolean", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "phase": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "tags": { "type": "string", "nullable": true }, "representativeIdentityId": { "type": "string", "nullable": true }, "representativeIndividualIdentityId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdateOrganizationRequestBody": { "title": "UpdateOrganizationRequestBody", "type": "object", "description": "(tsType: Partial, schemaOptions: { title: 'UpdateOrganizationRequestBody', partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true }, "mongoId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "highVolumePartner": { "type": "boolean", "nullable": true }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "string", "nullable": true }, "mouSigned": { "type": "boolean", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "phase": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "tags": { "type": "string", "nullable": true }, "representativeIdentityId": { "type": "string", "nullable": true }, "representativeIndividualIdentityId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NotificationService": {}, "InvestmentsTaxesRepository": {}, "UsersRepository": {}, "LedgerAccountsWithRelations": { "title": "LedgerAccountsWithRelations", "type": "object", "description": "(tsType: LedgerAccountsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "parentAccountId": { "type": "string", "nullable": true }, "ledgerId": { "type": "string", "nullable": false }, "referenceNumberId": { "type": "string", "nullable": false }, "currency": { "type": "string", "nullable": false }, "creditOrDebit": { "type": "string", "nullable": false }, "bankAccountId": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "parentAccount": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" }, "foreignKey": {}, "ledger": { "$ref": "#/components/schemas/LedgersWithRelations" }, "bankAccount": { "$ref": "#/components/schemas/BankAccountsWithRelations" }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountAssociationsWithRelations" } }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "LedgerAccountsWithRelations" }, "LedgerAccountAssociation": { "title": "LedgerAccountAssociation", "type": "object", "description": "(tsType: LedgerAccountAssociationsWithRelations, schemaOptions: { title: 'LedgerAccountAssociation', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "accountId": { "type": "string", "nullable": true }, "associationType": { "type": "string", "nullable": false }, "objectId": { "type": "string", "nullable": true }, "account": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "LedgerAccountAssociationsWithRelations" }, "LedgersWithRelations": { "title": "LedgersWithRelations", "type": "object", "description": "(tsType: LedgersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userId": { "type": "string", "nullable": false }, "organizationId": { "type": "string", "nullable": false }, "entityId": { "type": "string", "nullable": true }, "user": { "$ref": "#/components/schemas/UsersWithRelations" }, "foreignKey": {}, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "LedgersWithRelations" }, "BankAccountsWithRelations": { "title": "BankAccountsWithRelations", "type": "object", "description": "(tsType: BankAccountsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string", "nullable": true }, "accountNumber": { "type": "string", "nullable": true }, "routingNumber": { "type": "string", "nullable": true }, "accountName": { "type": "string", "nullable": true }, "bankName": { "type": "string", "nullable": true }, "lastSuccessfulSync": { "type": "string", "format": "date-time", "nullable": true }, "syncStatus": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "providerApplicationId": { "type": "string", "nullable": true }, "applicationStatus": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "providerData": { "type": "object", "nullable": true }, "currentBalance": { "type": "number", "nullable": true }, "availableBalance": { "type": "number", "nullable": true }, "notes": { "type": "string", "nullable": true }, "entityId": { "type": "string", "nullable": true }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "BankAccountsWithRelations" }, "LedgerAccountAssociationsWithRelations": { "title": "LedgerAccountAssociationsWithRelations", "type": "object", "description": "(tsType: LedgerAccountAssociationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "accountId": { "type": "string", "nullable": true }, "associationType": { "type": "string", "nullable": false }, "objectId": { "type": "string", "nullable": true }, "account": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "LedgerAccountAssociationsWithRelations" }, "LedgerEntriesWithRelations": { "title": "LedgerEntriesWithRelations", "type": "object", "description": "(tsType: LedgerEntriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userId": { "type": "string", "nullable": false }, "transactionId": { "type": "string", "nullable": false }, "accountId": { "type": "string", "nullable": false }, "counterAccountId": { "type": "string", "nullable": false }, "ledgerId": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": false }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": false }, "user": { "$ref": "#/components/schemas/UsersWithRelations" }, "foreignKey": {}, "transaction": { "$ref": "#/components/schemas/TransactionsWithRelations" }, "account": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" }, "counterAccount": { "$ref": "#/components/schemas/LedgersWithRelations" }, "ledger": { "$ref": "#/components/schemas/LedgersWithRelations" }, "ledgerEntryRelationships": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntryRelationshipsWithRelations" } } }, "required": [ "amount" ], "additionalProperties": false, "x-typescript-type": "LedgerEntriesWithRelations" }, "LedgerAccount": { "title": "LedgerAccount", "type": "object", "description": "(tsType: LedgerAccountsWithRelations, schemaOptions: { title: 'LedgerAccount', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "parentAccountId": { "type": "string", "nullable": true }, "ledgerId": { "type": "string", "nullable": false }, "referenceNumberId": { "type": "string", "nullable": false }, "currency": { "type": "string", "nullable": false }, "creditOrDebit": { "type": "string", "nullable": false }, "bankAccountId": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": true }, "detail": { "type": "string", "nullable": true }, "parentAccount": { "$ref": "#/components/schemas/LedgerAccountsWithRelations" }, "foreignKey": {}, "ledger": { "$ref": "#/components/schemas/LedgersWithRelations" }, "bankAccount": { "$ref": "#/components/schemas/BankAccountsWithRelations" }, "associations": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerAccountAssociationsWithRelations" } }, "entries": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "LedgerAccountsWithRelations" }, "LedgerEntry": { "title": "LedgerEntry", "type": "object", "description": "(tsType: LedgerEntries, schemaOptions: { title: 'LedgerEntry' })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userId": { "type": "string", "nullable": false }, "transactionId": { "type": "string", "nullable": false }, "accountId": { "type": "string", "nullable": false }, "counterAccountId": { "type": "string", "nullable": false }, "ledgerId": { "type": "string", "nullable": true }, "amount": { "type": "number", "nullable": false }, "description": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": false } }, "required": [ "amount" ], "additionalProperties": false, "x-typescript-type": "LedgerEntries" }, "IdentitiesWithRelations": { "title": "IdentitiesWithRelations", "type": "object", "description": "(tsType: IdentitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "parentIdentityId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "kycChecks": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityKycChecksWithRelations" } }, "identityFiles": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityFilesWithRelations" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/IdentitiesRelationsWithRelations" } }, "accreditations": { "type": "array", "items": { "$ref": "#/components/schemas/AccreditationsWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "IdentitiesWithRelations" }, "InvestmentsTaxesWithRelations": { "title": "InvestmentsTaxesWithRelations", "type": "object", "description": "(tsType: InvestmentsTaxesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": true }, "taxYear": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "investorIdentitiesId": { "type": "string", "nullable": true }, "investorLegalName": { "type": "string", "nullable": true }, "investorTaxId": { "type": "string", "nullable": true }, "investorStreetAddress": { "type": "string", "nullable": true }, "investorCity": { "type": "string", "nullable": true }, "investorState": { "type": "string", "nullable": true }, "investorPostalCode": { "type": "string", "nullable": true }, "investorIsUsDomestic": { "type": "boolean", "nullable": true }, "investorFcAndSoiAndDApplicable": { "type": "boolean", "nullable": true }, "investorOtherDeductions": { "type": "number", "nullable": true }, "investorContributions": { "type": "number", "default": 0 }, "investorDistributions": { "type": "number", "nullable": true }, "dealId": { "type": "string", "nullable": true }, "investorEntityType": { "type": "string", "nullable": true }, "investorEntityIsDisregarded": { "type": "boolean", "default": false }, "investorDisregardedOwnerName": { "type": "string", "nullable": true }, "investorDisregardedOwnerTaxId": { "type": "string", "nullable": true }, "investorBeginningProfitPercentage": { "type": "number", "default": 0 }, "investorBeginningLossPercentage": { "type": "number", "default": 0 }, "investorBeginningCapitalPercentage": { "type": "number", "default": 0 }, "investorForeignTaxCreditLimitationApplicable": { "type": "boolean", "nullable": true, "default": false }, "investorCountry": { "type": "string", "nullable": true }, "investorEndingProfitPercentage": { "type": "number", "default": 0 }, "investorEndingLossPercentage": { "type": "number", "default": 0 }, "investorEndingCapitalPercentage": { "type": "number", "default": 0 }, "k1FilesId": { "type": "string", "nullable": true }, "investorOwnershipPercent": { "type": "number", "default": 0 }, "investorCurrentYearNetIncomeLoss": { "type": "number", "default": 0 }, "investorEndingCapitalAccountAmount": { "type": "number", "default": 0 }, "investorBeginningCapitalAccountAmount": { "type": "number", "default": 0 }, "legacyRecordId": { "type": "string", "nullable": true }, "calculatorVersion": { "type": "string", "nullable": true }, "partnerIndex": { "type": "number", "nullable": true }, "investorEmail": { "type": "string", "nullable": true }, "lastPrintedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "investmentId": { "type": "string" }, "entityId": { "type": "string" }, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "foreignKey": {}, "entities": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InvestmentsTaxesWithRelations" }, "FilesWithRelations": { "title": "FilesWithRelations", "type": "object", "description": "(tsType: FilesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "key": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "mongoOwnerId": { "type": "string", "nullable": true }, "legacyBucket": { "type": "string", "nullable": true }, "legacyKey": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mongoDocumentsId": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "bucket": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "FilesWithRelations" }, "InvestmentsTransferInformationWithRelations": { "title": "InvestmentsTransferInformation", "type": "object", "description": "(tsType: InvestmentsTransferInformation, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "investmentId": { "type": "string", "nullable": true }, "transferInformationId": { "type": "string", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "InvestmentsTransferInformation" }, "Investment": { "title": "Investment", "type": "object", "description": "(tsType: InvestmentsWithRelations, schemaOptions: { title: 'Investment', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "blueskyFees": { "type": "number", "nullable": true }, "capitalWiredAmount": { "type": "number" }, "carry": { "type": "number", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "managementFeesDollars": { "type": "number", "nullable": true }, "netInvestment": { "type": "number", "nullable": true }, "otherExpenses": { "type": "number", "nullable": true }, "privateFundExpenses": { "type": "number", "nullable": true }, "spvFees": { "type": "number", "nullable": true }, "subscriptionAmount": { "type": "number", "nullable": true }, "completeAt": { "type": "string", "format": "date-time", "nullable": true }, "ledgerMatched": { "type": "boolean", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoInvestmentId": { "type": "string", "nullable": true }, "mongoUserId": { "type": "string", "nullable": true }, "invitedAtLegacy": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "manualEntryWireDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true }, "invitedAt": { "type": "string", "format": "date-time", "nullable": true }, "wiredDate": { "type": "string", "format": "date-time", "nullable": true }, "distributionAssetType": { "type": "string", "nullable": true, "enum": [ "Cash", "Stock", "USDT", "USDC" ] }, "distributionTransferInfoId": { "type": "string", "format": "uuid" }, "identitiesId": { "type": "string" }, "dealId": { "type": "string" }, "userId": { "type": "string" }, "distributionTransferInformation": { "$ref": "#/components/schemas/TransferInformationWithRelations" }, "foreignKey": {}, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "investmentsTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTaxesWithRelations" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FilesWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTransferInformationWithRelations" } } }, "required": [ "userId" ], "additionalProperties": false, "x-typescript-type": "InvestmentsWithRelations" }, "updateInvestmentByIdBody": { "title": "updateInvestmentByIdBody", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn'>, schemaOptions: { title: 'updateInvestmentByIdBody', partial: true, exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn' ] })", "properties": { "deletedBy": { "type": "string", "nullable": true }, "blueskyFees": { "type": "number", "nullable": true }, "capitalWiredAmount": { "type": "number" }, "carry": { "type": "number", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "managementFeesDollars": { "type": "number", "nullable": true }, "netInvestment": { "type": "number", "nullable": true }, "otherExpenses": { "type": "number", "nullable": true }, "privateFundExpenses": { "type": "number", "nullable": true }, "spvFees": { "type": "number", "nullable": true }, "subscriptionAmount": { "type": "number", "nullable": true }, "completeAt": { "type": "string", "format": "date-time", "nullable": true }, "ledgerMatched": { "type": "boolean", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoInvestmentId": { "type": "string", "nullable": true }, "mongoUserId": { "type": "string", "nullable": true }, "invitedAtLegacy": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "manualEntryWireDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true }, "invitedAt": { "type": "string", "format": "date-time", "nullable": true }, "wiredDate": { "type": "string", "format": "date-time", "nullable": true }, "distributionAssetType": { "type": "string", "nullable": true, "enum": [ "Cash", "Stock", "USDT", "USDC" ] }, "distributionTransferInfoId": { "type": "string", "format": "uuid" }, "identitiesId": { "type": "string" }, "dealId": { "type": "string" }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn'>" }, "InvestmentTransferInformation": { "title": "InvestmentTransferInformation", "type": "object", "description": "(tsType: InvestmentsTransferInformation, schemaOptions: { title: 'InvestmentTransferInformation' })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "investmentId": { "type": "string", "nullable": true }, "transferInformationId": { "type": "string", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "InvestmentsTransferInformation" }, "IdentityFiles": { "title": "IdentityFiles", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'IdentityFiles', exclude: [ 'deleted', 'deletedOn', 'deletedBy', 'validationResult', 'validationRawResult', 'provider', 'path', 'providerId' ] })", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "mimeType": { "type": "string", "enum": [ "application/pdf", "image/png", "image/jpeg" ] }, "fileType": { "type": "string", "enum": [ "source_of_funds", "w_8", "w_9", "w_8_ben", "w_8_bene", "passport", "driving_license", "national_identity_card", "residence_permit", "passport_card", "tax_id", "visa", "voter_id", "entity_formation", "residence_status_document", "postal_identity_card", "social_security_card", "work_permit", "asylum_registration_card", "national_health_insurance_card", "municipality_identity_card", "private_operators_card", "proof_of_citizenship", "service_id_card", "immigration_status_document", "indigenous_card", "vehicle_registration_card", "certificate_of_naturalisation", "professional_qualification_card", "consular_id", "international_driving_licence", "bank_building_society_statement", "utility_bill", "council_tax", "benefit_letters", "mortgage_statement", "mobile_phone_bill", "general_letter", "pension_property_statement_letter", "insurance_statement", "exchange_house_statement", "accommodation_tenancy_certificate", "wire_instructions" ] }, "side": { "type": "string", "nullable": false, "enum": [ "front", "back" ] }, "identityId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "IdentityFilesWithRelations": { "title": "IdentityFilesWithRelations", "type": "object", "description": "(tsType: IdentityFilesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "path": { "type": "string" }, "mimeType": { "type": "string", "enum": [ "application/pdf", "image/png", "image/jpeg" ] }, "fileType": { "type": "string", "enum": [ "source_of_funds", "w_8", "w_9", "w_8_ben", "w_8_bene", "passport", "driving_license", "national_identity_card", "residence_permit", "passport_card", "tax_id", "visa", "voter_id", "entity_formation", "residence_status_document", "postal_identity_card", "social_security_card", "work_permit", "asylum_registration_card", "national_health_insurance_card", "municipality_identity_card", "private_operators_card", "proof_of_citizenship", "service_id_card", "immigration_status_document", "indigenous_card", "vehicle_registration_card", "certificate_of_naturalisation", "professional_qualification_card", "consular_id", "international_driving_licence", "bank_building_society_statement", "utility_bill", "council_tax", "benefit_letters", "mortgage_statement", "mobile_phone_bill", "general_letter", "pension_property_statement_letter", "insurance_statement", "exchange_house_statement", "accommodation_tenancy_certificate", "wire_instructions" ] }, "side": { "type": "string", "nullable": false, "enum": [ "front", "back" ] }, "validationResult": { "type": "string" }, "validationRawResult": { "type": "object" }, "provider": { "type": "string" }, "providerId": { "type": "string" }, "identityId": { "type": "string" }, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "IdentityFilesWithRelations" }, "Identities": { "title": "Identities", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "parentIdentityId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "CreateIdentityRequestBody": { "title": "CreateIdentityRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateIdentityRequestBody', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "parentIdentityId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "AccreditationsWithRelations": { "title": "AccreditationsWithRelations", "type": "object", "description": "(tsType: AccreditationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "user_investment_entity_id": { "type": "string", "nullable": true, "format": "uuid" }, "description": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "identitiesId": { "type": "string", "nullable": true, "format": "uuid" }, "userId": { "type": "string" }, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "AccreditationsWithRelations" }, "IdentitiesRelationsWithRelations": { "title": "IdentitiesRelationsWithRelations", "type": "object", "description": "(tsType: IdentitiesRelationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "relationship": { "type": "string", "nullable": false, "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "ownershipPercentage": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true }, "childId": { "type": "string", "nullable": false }, "parentId": { "type": "string", "nullable": false }, "userEmail": { "type": "string", "nullable": false }, "userId": { "type": "string" }, "child": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "parent": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "IdentitiesRelationsWithRelations" }, "IdentityKycChecksWithRelations": { "title": "IdentityKycChecks", "type": "object", "description": "(tsType: IdentityKycChecks, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "result": { "type": "string", "nullable": false }, "status": { "type": "string", "nullable": false }, "provider": { "type": "string", "nullable": false }, "providerId": { "type": "string", "nullable": false }, "identityData": { "type": "object", "nullable": false }, "rawResults": { "type": "object", "nullable": true }, "completedAt": { "type": "string", "format": "date-time", "nullable": true }, "identityId": { "type": "string", "nullable": false } }, "required": [ "identityData" ], "additionalProperties": false, "x-typescript-type": "IdentityKycChecks" }, "IdentityWithArchivableDtoWithRelations": { "title": "IdentityWithArchivableDtoWithRelations", "type": "object", "description": "(tsType: IdentityWithArchivableDtoWithRelations, schemaOptions: { title: 'IdentityWithArchivableDtoWithRelations', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false, "format": "uuid" }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true, "format": "uuid" }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "archivable": { "type": "boolean", "nullable": false }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "accreditations": { "type": "array", "items": { "$ref": "#/components/schemas/AccreditationsWithRelations" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/IdentitiesRelationsWithRelations" } }, "identityFiles": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityFilesWithRelations" } }, "kycChecks": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityKycChecksWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } }, "required": [ "id", "archivable" ], "additionalProperties": false, "x-typescript-type": "IdentityWithArchivableDtoWithRelations" }, "UpdateIdentityRequestBody": { "title": "UpdateIdentityRequestBody", "type": "object", "description": "(tsType: Partial, schemaOptions: { title: 'UpdateIdentityRequestBody', partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "parentIdentityId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "InvalidIdentityWithArchivable": { "title": "InvalidIdentityWithArchivable", "type": "object", "description": "(tsType: InvalidIdentityWithArchivableDto, schemaOptions: { title: 'InvalidIdentityWithArchivable' })", "properties": { "identity": { "type": "object", "$ref": "#/components/schemas/IdentityWithArchivableDtoWithRelations" }, "detail": { "type": "object", "properties": { "result": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object" } } } } }, "required": [ "identity", "detail" ], "additionalProperties": false, "x-typescript-type": "InvalidIdentityWithArchivableDto" }, "IdentityService": {}, "IdentityValidationService": {}, "IdentitiesRelations": { "title": "IdentitiesRelations", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "relationship": { "type": "string", "nullable": false, "enum": [ "signer", "partnership_representative", "designated_individual", "beneficial_owner", "control_person" ] }, "ownershipPercentage": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true }, "childId": { "type": "string", "nullable": false }, "parentId": { "type": "string", "nullable": false }, "userEmail": { "type": "string", "nullable": false }, "userId": { "type": "string" } }, "additionalProperties": false }, "CreateIdentityRelationshipRequestBody": { "title": "CreateIdentityRelationshipRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateIdentityRelationshipRequestBody', exclude: [ 'id', 'childId', 'parentId', 'relationship', 'userEmail', 'userId' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "ownershipPercentage": { "type": "number", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "FileStorageService": {}, "PlatformFeature": { "title": "PlatformFeature", "type": "object", "description": "(tsType: PlatformFeature, schemaOptions: { title: 'PlatformFeature' })", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "isEnabled": { "type": "boolean" }, "isActiveGlobally": { "type": "boolean" } }, "required": [ "id", "name", "isEnabled", "isActiveGlobally" ], "additionalProperties": false, "x-typescript-type": "PlatformFeature" }, "CreateEntityRequestBody": { "title": "CreateEntityRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateEntityRequestBody', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "formationDate": { "type": "string", "format": "date-time", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "fundManager": { "type": "string", "nullable": true }, "taxStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "returnId": { "type": "string", "nullable": true }, "taxesProvider": { "type": "string", "nullable": true }, "taxesProviderId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "partnershipRepresentativeId": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualId": { "type": "string", "nullable": true }, "parentEntityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdateEntityRequestBody": { "title": "UpdateEntityRequestBody", "type": "object", "description": "(tsType: Partial, schemaOptions: { title: 'UpdateEntityRequestBody', partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "formationDate": { "type": "string", "format": "date-time", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "fundManager": { "type": "string", "nullable": true }, "taxStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "returnId": { "type": "string", "nullable": true }, "taxesProvider": { "type": "string", "nullable": true }, "taxesProviderId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "partnershipRepresentativeId": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualId": { "type": "string", "nullable": true }, "parentEntityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Entities": { "title": "Entities", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "formationDate": { "type": "string", "format": "date-time", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "fundManager": { "type": "string", "nullable": true }, "taxStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "returnId": { "type": "string", "nullable": true }, "taxesProvider": { "type": "string", "nullable": true }, "taxesProviderId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "partnershipRepresentativeId": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualId": { "type": "string", "nullable": true }, "parentEntityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntitiesTaxesWithRelations": { "title": "EntitiesTaxes", "type": "object", "description": "(tsType: EntitiesTaxes, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "irsAcceptedDate": { "type": "string", "format": "date-time", "nullable": true }, "importRequested": { "type": "string", "format": "date-time", "nullable": true }, "lastImportedAt": { "type": "string", "format": "date-time", "nullable": true }, "printRequested": { "type": "string", "format": "date-time", "nullable": true }, "lastPrintedAt": { "type": "string", "format": "date-time", "nullable": true }, "importState": { "type": "string", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "entityEin": { "type": "string", "nullable": true }, "entityFormationDate": { "type": "string", "format": "date-time", "nullable": true }, "entityStreetAddress": { "type": "string", "nullable": true }, "entityCity": { "type": "string", "nullable": true }, "entityState": { "type": "string", "nullable": true }, "entityPostalCode": { "type": "string", "nullable": true }, "entityPhoneNumber": { "type": "string", "nullable": true }, "signerFirstName": { "type": "string", "nullable": true }, "signerLastName": { "type": "string", "nullable": true }, "signerTitle": { "type": "string", "nullable": true }, "signerSignatureDate": { "type": "string", "format": "date-time", "nullable": true }, "signerSignature": { "type": "string", "nullable": true }, "isInitialReturn": { "type": "boolean", "nullable": false }, "isAmendmentReturn": { "type": "boolean", "nullable": false }, "isFinalReturn": { "type": "boolean", "nullable": false }, "entityType": { "type": "string", "nullable": true }, "entitySatisfiesReceiptsAndAssets": { "type": "boolean", "nullable": false }, "partnershipRepresentativeName": { "type": "string", "nullable": true }, "partnershipRepresentativeStreetAddress": { "type": "string", "nullable": true }, "partnershipRepresentativeCity": { "type": "string", "nullable": true }, "partnershipRepresentativeZip": { "type": "string", "nullable": true }, "partnershipRepresentativePhone": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualFirstName": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualLastName": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualStreetAddress": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualCity": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualState": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualZip": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualPhone": { "type": "string", "nullable": true }, "entityBeginningCash": { "type": "number", "nullable": true }, "entityEndingCash": { "type": "number", "nullable": true }, "entityBeginningLongTermAssets": { "type": "number", "nullable": true }, "entityEndingLongTermAssets": { "type": "number", "nullable": true }, "entityBeginningCurrentLiabilities": { "type": "number", "nullable": true }, "entityEndingCurrentLiabilities": { "type": "number", "nullable": true }, "entityBeginningCapital": { "type": "number", "nullable": true }, "entityCapitalContributions": { "type": "number", "nullable": true }, "entityCashDistributions": { "type": "number", "nullable": true }, "entityPortfolioExpense": { "type": "number", "nullable": true }, "entityHasForeignInvestors": { "type": "boolean", "nullable": false }, "hasNotifiedLps": { "type": "boolean", "nullable": false }, "taxYear": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "taxType": { "type": "string", "nullable": true }, "portfolioExpenseDescription": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualEmail": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "extensionFiled": { "type": "boolean", "nullable": false }, "partnershipRepresentativeState": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "batch": { "type": "number", "nullable": true }, "allocationsApproval": { "type": "string", "format": "date-time", "nullable": true }, "fundManagerApprovalDate": { "type": "string", "nullable": true }, "1065FilesId": { "type": "string", "nullable": true }, "fundManagerApprovalEmail": { "type": "string", "nullable": true }, "fundManagerInvited": { "type": "boolean", "nullable": true }, "fundManagerApproval": { "type": "boolean", "nullable": true }, "calculatorVersion": { "type": "string", "nullable": true }, "irsSubmissionId": { "type": "string", "nullable": true }, "entityId": { "type": "string" } }, "required": [ "isInitialReturn", "isAmendmentReturn", "isFinalReturn", "entitySatisfiesReceiptsAndAssets", "entityHasForeignInvestors", "hasNotifiedLps", "extensionFiled" ], "additionalProperties": false, "x-typescript-type": "EntitiesTaxes" }, "DistributionEventsWithRelations": { "title": "DistributionEventsWithRelations", "type": "object", "description": "(tsType: DistributionEventsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "distributionId": { "type": "string", "nullable": false }, "dealId": { "type": "string", "nullable": false }, "userId": { "type": "string", "nullable": false }, "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "receivingAssetType": { "type": "string", "nullable": false, "enum": [ "cash", "stock" ] }, "distributingAssetType": { "type": "string", "nullable": false, "enum": [ "cash", "stock" ] }, "amount": { "type": "number", "nullable": true }, "requestedReceivingDate": { "type": "string", "format": "date-time", "nullable": true }, "date": { "type": "string", "format": "date-time", "nullable": true }, "note": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "distribution": { "$ref": "#/components/schemas/DistributionsWithRelations" }, "foreignKey": {}, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "DistributionEventsWithRelations" }, "DistributionsWithRelations": { "title": "DistributionsWithRelations", "type": "object", "description": "(tsType: DistributionsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "userId": { "type": "string", "nullable": false }, "requestedReceivingDate": { "type": "string", "format": "date-time", "nullable": true }, "note": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "distributionsInvestments": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionsInvestmentsWithRelations" } }, "distributionEvents": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionEventsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "DistributionsWithRelations" }, "DistributionsInvestmentsWithRelations": { "title": "DistributionsInvestmentsWithRelations", "type": "object", "description": "(tsType: DistributionsInvestmentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "amount": { "type": "number", "nullable": true }, "transferInformation": { "type": "object", "nullable": true }, "method": { "type": "string", "nullable": true }, "distributionDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true, "enum": [ "submitted", "processing", "wired" ] }, "transactionHash": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "distributionId": { "type": "string", "nullable": false }, "investmentId": { "type": "string", "nullable": false }, "distribution": { "$ref": "#/components/schemas/DistributionsWithRelations" }, "foreignKey": {}, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "additionalProperties": false, "x-typescript-type": "DistributionsInvestmentsWithRelations" }, "Distribution": { "title": "Distribution", "type": "object", "description": "(tsType: DistributionsWithRelations, schemaOptions: { title: 'Distribution', includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "userId": { "type": "string", "nullable": false }, "requestedReceivingDate": { "type": "string", "format": "date-time", "nullable": true }, "note": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "distributionsInvestments": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionsInvestmentsWithRelations" } }, "distributionEvents": { "type": "array", "items": { "$ref": "#/components/schemas/DistributionEventsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "DistributionsWithRelations" }, "CreateDistributionDto": { "title": "CreateDistributionDto", "type": "object", "properties": { "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "userId": { "type": "string", "nullable": false, "format": "uuid" }, "dealId": { "type": "string", "nullable": false, "format": "uuid" }, "requestedReceivingDate": { "type": "string", "nullable": true, "format": "date" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "sheetUri": { "type": "string", "nullable": true } }, "required": [ "status", "userId", "dealId" ], "additionalProperties": false }, "UpdateDistributionDto": { "title": "UpdateDistributionDto", "type": "object", "properties": { "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "requestedReceivingDate": { "type": "string", "nullable": true, "format": "date" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "sheetUri": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BulkUpdateDistributionsDto": { "title": "BulkUpdateDistributionsDto", "type": "object", "description": "(tsType: BulkUpdateDistributionsDto, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false, "format": "uuid" }, "status": { "type": "string", "nullable": false, "enum": [ "draft", "submitted", "processing", "completed", "requested" ] }, "requestedReceivingDate": { "type": "string", "nullable": true, "format": "date" }, "note": { "type": "string", "nullable": true, "maxLength": 1000 }, "sheetUri": { "type": "string", "nullable": true } }, "required": [ "id" ], "additionalProperties": false, "x-typescript-type": "BulkUpdateDistributionsDto" }, "CreateDistributionInvestmentDto": { "title": "CreateDistributionInvestmentDto", "type": "object", "properties": { "distributionId": { "type": "string", "nullable": false, "format": "uuid" }, "investmentId": { "type": "string", "nullable": false, "format": "uuid" }, "amount": { "type": "number", "nullable": false, "minimum": 0 }, "transferInformationId": { "type": "string", "nullable": true, "format": "uuid" }, "method": { "type": "string", "nullable": false }, "distributionDate": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true, "enum": [ "submitted", "processing", "wired" ] } }, "required": [ "distributionId", "investmentId", "amount" ], "additionalProperties": false }, "UpdateDistributionInvestmentDto": { "title": "UpdateDistributionInvestmentDto", "type": "object", "properties": { "distributionId": { "type": "string", "nullable": false, "format": "uuid" }, "investmentId": { "type": "string", "nullable": false, "format": "uuid" }, "amount": { "type": "number", "nullable": true, "minimum": 0 }, "method": { "type": "string", "nullable": true }, "distributionDate": { "type": "string", "format": "date-time", "nullable": true }, "status": { "type": "string", "nullable": true, "enum": [ "submitted", "processing", "wired" ] } }, "additionalProperties": false }, "Deals": { "title": "Deals", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "minimumInvestment": { "type": "number", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "offeringType": { "type": "string", "nullable": true }, "managementFeeFrequency": { "type": "string", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "targetRaiseGoal": { "type": "number", "nullable": true }, "totalCarry": { "type": "number", "nullable": true }, "slug": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "documentsTemplateId": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "shortcodeId": { "type": "string", "nullable": true }, "totalCarryNotes": { "type": "string", "nullable": true }, "managementFeeNotes": { "type": "string", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "string", "nullable": true }, "migrationApproval": { "type": "boolean", "nullable": true }, "migrationApprovalDate": { "type": "string", "nullable": true }, "migrationApprovalEmail": { "type": "string", "nullable": true }, "migrationFmSent": { "type": "boolean", "nullable": true }, "invoiceAmount": { "type": "number", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceStatus": { "type": "string", "nullable": true }, "capitalAccountStatementURI": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time", "nullable": true }, "advisorStatus": { "type": "string", "nullable": true }, "entityId": { "type": "string" }, "fmIdentityId": { "type": "string" }, "advisorId": { "type": "string", "nullable": true }, "organizationId": { "type": "string" } }, "additionalProperties": false }, "NewDeals": { "title": "NewDeals", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDeals', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "minimumInvestment": { "type": "number", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "offeringType": { "type": "string", "nullable": true }, "managementFeeFrequency": { "type": "string", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "targetRaiseGoal": { "type": "number", "nullable": true }, "totalCarry": { "type": "number", "nullable": true }, "slug": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "documentsTemplateId": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "shortcodeId": { "type": "string", "nullable": true }, "totalCarryNotes": { "type": "string", "nullable": true }, "managementFeeNotes": { "type": "string", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "string", "nullable": true }, "migrationApproval": { "type": "boolean", "nullable": true }, "migrationApprovalDate": { "type": "string", "nullable": true }, "migrationApprovalEmail": { "type": "string", "nullable": true }, "migrationFmSent": { "type": "boolean", "nullable": true }, "invoiceAmount": { "type": "number", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceStatus": { "type": "string", "nullable": true }, "capitalAccountStatementURI": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time", "nullable": true }, "advisorStatus": { "type": "string", "nullable": true }, "entityId": { "type": "string" }, "fmIdentityId": { "type": "string" }, "advisorId": { "type": "string", "nullable": true }, "organizationId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "DealSummaryWithRelations": { "title": "DealSummaryWithRelations", "type": "object", "description": "(tsType: DealSummaryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "entityName": { "type": "string" }, "entityEin": { "type": "string" }, "totalRaisedWired": { "type": "number" }, "totalRaisedSubscribed": { "type": "number" }, "investorCount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "type", "status", "totalRaisedWired", "investorCount" ], "additionalProperties": false, "x-typescript-type": "DealSummaryWithRelations" }, "DealDetailsWithRelations": { "title": "DealDetails", "type": "object", "description": "(tsType: DealDetails, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "acceptCrypto": { "type": "boolean", "nullable": true }, "advisorType": { "type": "string", "nullable": true }, "assetId": { "type": "string", "nullable": true }, "bankAccountId": { "type": "string", "nullable": true }, "bankingProvider": { "type": "string", "nullable": true }, "dealTerm": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "estimatedMultiple": { "type": "number", "nullable": true }, "estimatedAssetCount": { "type": "number", "nullable": true }, "internationalInvestors": { "type": "boolean", "nullable": true }, "hasAccreditedInvestors": { "type": "boolean", "nullable": true }, "hasQualifiedPurchasers": { "type": "boolean", "nullable": true }, "hasInstitutionalInvestors": { "type": "boolean", "nullable": true }, "internationalTransactionsExpected": { "type": "boolean", "nullable": true }, "nonUsFinancialInstitutions": { "type": "boolean", "nullable": true }, "legacyCompanyName": { "type": "string", "nullable": true }, "legalTemplateOption": { "type": "string", "nullable": true }, "masterSeries": { "type": "string", "nullable": true }, "onboardingLink": { "type": "string", "nullable": true }, "seriesName": { "type": "string", "nullable": true }, "subType": { "type": "string", "nullable": true }, "agreeMsa": { "type": "boolean", "nullable": true }, "agreeCosts": { "type": "boolean", "nullable": true }, "agreeSetup": { "type": "boolean", "nullable": true }, "masterSeriesId": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "advisorTypeNote": { "type": "string", "nullable": true }, "bankingProviderNote": { "type": "string", "nullable": true }, "fundManagerEmail": { "type": "string", "nullable": true }, "financialStatementFrequency": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "DealDetails" }, "DealsPartial": { "title": "DealsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "minimumInvestment": { "type": "number", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "offeringType": { "type": "string", "nullable": true }, "managementFeeFrequency": { "type": "string", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "targetRaiseGoal": { "type": "number", "nullable": true }, "totalCarry": { "type": "number", "nullable": true }, "slug": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "documentsTemplateId": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "shortcodeId": { "type": "string", "nullable": true }, "totalCarryNotes": { "type": "string", "nullable": true }, "managementFeeNotes": { "type": "string", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "string", "nullable": true }, "migrationApproval": { "type": "boolean", "nullable": true }, "migrationApprovalDate": { "type": "string", "nullable": true }, "migrationApprovalEmail": { "type": "string", "nullable": true }, "migrationFmSent": { "type": "boolean", "nullable": true }, "invoiceAmount": { "type": "number", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceStatus": { "type": "string", "nullable": true }, "capitalAccountStatementURI": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time", "nullable": true }, "advisorStatus": { "type": "string", "nullable": true }, "entityId": { "type": "string" }, "fmIdentityId": { "type": "string" }, "advisorId": { "type": "string", "nullable": true }, "organizationId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DealDetailsPartial": { "title": "DealDetailsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "acceptCrypto": { "type": "boolean", "nullable": true }, "advisorType": { "type": "string", "nullable": true }, "assetId": { "type": "string", "nullable": true }, "bankAccountId": { "type": "string", "nullable": true }, "bankingProvider": { "type": "string", "nullable": true }, "dealTerm": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "estimatedMultiple": { "type": "number", "nullable": true }, "estimatedAssetCount": { "type": "number", "nullable": true }, "internationalInvestors": { "type": "boolean", "nullable": true }, "hasAccreditedInvestors": { "type": "boolean", "nullable": true }, "hasQualifiedPurchasers": { "type": "boolean", "nullable": true }, "hasInstitutionalInvestors": { "type": "boolean", "nullable": true }, "internationalTransactionsExpected": { "type": "boolean", "nullable": true }, "nonUsFinancialInstitutions": { "type": "boolean", "nullable": true }, "legacyCompanyName": { "type": "string", "nullable": true }, "legalTemplateOption": { "type": "string", "nullable": true }, "masterSeries": { "type": "string", "nullable": true }, "onboardingLink": { "type": "string", "nullable": true }, "seriesName": { "type": "string", "nullable": true }, "subType": { "type": "string", "nullable": true }, "agreeMsa": { "type": "boolean", "nullable": true }, "agreeCosts": { "type": "boolean", "nullable": true }, "agreeSetup": { "type": "boolean", "nullable": true }, "masterSeriesId": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "advisorTypeNote": { "type": "string", "nullable": true }, "bankingProviderNote": { "type": "string", "nullable": true }, "fundManagerEmail": { "type": "string", "nullable": true }, "financialStatementFrequency": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DealDetails": { "title": "DealDetails", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "acceptCrypto": { "type": "boolean", "nullable": true }, "advisorType": { "type": "string", "nullable": true }, "assetId": { "type": "string", "nullable": true }, "bankAccountId": { "type": "string", "nullable": true }, "bankingProvider": { "type": "string", "nullable": true }, "dealTerm": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "estimatedMultiple": { "type": "number", "nullable": true }, "estimatedAssetCount": { "type": "number", "nullable": true }, "internationalInvestors": { "type": "boolean", "nullable": true }, "hasAccreditedInvestors": { "type": "boolean", "nullable": true }, "hasQualifiedPurchasers": { "type": "boolean", "nullable": true }, "hasInstitutionalInvestors": { "type": "boolean", "nullable": true }, "internationalTransactionsExpected": { "type": "boolean", "nullable": true }, "nonUsFinancialInstitutions": { "type": "boolean", "nullable": true }, "legacyCompanyName": { "type": "string", "nullable": true }, "legalTemplateOption": { "type": "string", "nullable": true }, "masterSeries": { "type": "string", "nullable": true }, "onboardingLink": { "type": "string", "nullable": true }, "seriesName": { "type": "string", "nullable": true }, "subType": { "type": "string", "nullable": true }, "agreeMsa": { "type": "boolean", "nullable": true }, "agreeCosts": { "type": "boolean", "nullable": true }, "agreeSetup": { "type": "boolean", "nullable": true }, "masterSeriesId": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "advisorTypeNote": { "type": "string", "nullable": true }, "bankingProviderNote": { "type": "string", "nullable": true }, "fundManagerEmail": { "type": "string", "nullable": true }, "financialStatementFrequency": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClosesWithRelations": { "title": "ClosesWithRelations", "type": "object", "description": "(tsType: ClosesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationsId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true }, "requestedCloseAmount": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dealsId": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "ClosesWithRelations" }, "NewCloseRequest": { "title": "NewCloseRequest", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCloseRequest', exclude: [ 'id', 'createdAt' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationsId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true }, "requestedCloseAmount": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dealsId": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ClosesPartial": { "title": "ClosesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationsId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true }, "requestedCloseAmount": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dealsId": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Closes": { "title": "Closes", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationsId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true }, "requestedCloseAmount": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dealsId": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "InvitationsWithRelations": { "title": "InvitationsWithRelations", "type": "object", "description": "(tsType: InvitationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "recipientEmail": { "type": "string" }, "dealId": { "type": "string", "nullable": false }, "amount": { "type": "number" }, "type": { "type": "string" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {} }, "required": [ "recipientEmail", "dealId", "amount" ], "additionalProperties": false, "x-typescript-type": "InvitationsWithRelations" }, "NewInvitation": { "title": "NewInvitation", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewInvitation', exclude: [ 'id' ] })", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "recipientEmail": { "type": "string" }, "dealId": { "type": "string", "nullable": false }, "amount": { "type": "number" }, "type": { "type": "string" } }, "required": [ "recipientEmail", "dealId", "amount" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "Files": { "title": "Files", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "key": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "mongoOwnerId": { "type": "string", "nullable": true }, "legacyBucket": { "type": "string", "nullable": true }, "legacyKey": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mongoDocumentsId": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "bucket": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AssetsWithRelations": { "title": "AssetsWithRelations", "type": "object", "description": "(tsType: AssetsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "legalName": { "type": "string", "nullable": false }, "securityType": { "type": "string", "nullable": false }, "purchaseAgreementId": { "type": "string", "nullable": true }, "wireInstructionsId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": false }, "industry": { "type": "string", "nullable": true }, "portfolioCompanyContact": { "type": "string", "nullable": true }, "portfolioCompanyPhone": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "valuation": { "type": "number", "nullable": true }, "valuationDate": { "type": "string", "format": "date-time", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "conversionTarget": { "type": "string", "nullable": true, "enum": [ "equity", "tokens", "both", "tbd" ] }, "conversionTrigger": { "type": "string", "nullable": true, "enum": [ "priced_round", "token_launch", "liquidity_event", "other" ] }, "hasTokenLinkedPayout": { "type": "boolean", "nullable": true }, "fundManagerLegalName": { "type": "string", "nullable": true }, "issuerLegalName": { "type": "string", "nullable": true }, "borrowerLegalName": { "type": "string", "nullable": true }, "stockCompanyLegalName": { "type": "string", "nullable": true }, "otherLegalName": { "type": "string", "nullable": true }, "fundManagerJurisdiction": { "type": "string", "nullable": true }, "borrowerJurisdiction": { "type": "string", "nullable": true }, "otherJurisdiction": { "type": "string", "nullable": true }, "otherTypeDescription": { "type": "string", "nullable": true }, "otherRegulatedActivities": { "type": "boolean", "nullable": true }, "noteSecurity": { "type": "string", "nullable": true }, "debtRepayment": { "type": "string", "nullable": true }, "fundStrategy": { "type": "string", "nullable": true }, "hasDigitalAssetExposure": { "type": "boolean", "nullable": true }, "stockBlockchainProducts": { "type": "boolean", "nullable": true }, "stockRegulatedActivities": { "type": "boolean", "nullable": true }, "digitalAssetExposureDescription": { "type": "string", "nullable": true }, "isVaspRegistered": { "type": "boolean", "nullable": true }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "AssetsWithRelations" }, "DealsViews": { "title": "DealsViews", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "dealId": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false } }, "additionalProperties": false }, "BulkUpdateClosesDto": { "title": "BulkUpdateClosesDto", "type": "object", "description": "(tsType: BulkUpdateClosesDto, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false, "format": "uuid" }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true, "minimum": 0 }, "requestedCloseAmount": { "type": "number", "nullable": true, "minimum": 0 }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true } }, "required": [ "id" ], "additionalProperties": false, "x-typescript-type": "BulkUpdateClosesDto" }, "UpdateBankAccountRequestBody": { "title": "UpdateBankAccountRequestBody", "type": "object", "description": "(tsType: Omit, 'providerData' | 'provider' | 'dealId' | 'accountNumber' | 'accountName' | 'bankName' | 'providerId' | 'id' | 'syncStatus' | 'availableBalance' | 'currentBalance' | 'userEmail' | 'routingNumber' | 'createdAt' | 'updatedAt' | 'entityId'>, schemaOptions: {\n title: 'UpdateBankAccountRequestBody',\n partial: true,\n exclude: [\n 'providerData', 'provider',\n 'dealId', 'accountNumber',\n 'accountName', 'bankName',\n 'providerId', 'id',\n 'syncStatus', 'availableBalance',\n 'currentBalance', 'userEmail',\n 'routingNumber', 'createdAt',\n 'updatedAt', 'entityId'\n ]\n})", "properties": { "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "lastSuccessfulSync": { "type": "string", "format": "date-time", "nullable": true }, "providerApplicationId": { "type": "string", "nullable": true }, "applicationStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'providerData' | 'provider' | 'dealId' | 'accountNumber' | 'accountName' | 'bankName' | 'providerId' | 'id' | 'syncStatus' | 'availableBalance' | 'currentBalance' | 'userEmail' | 'routingNumber' | 'createdAt' | 'updatedAt' | 'entityId'>" }, "BullMqComponent": {}, "DealsService": {}, "DocumentsGeneratorService": {}, "DynamicProviderService": {}, "BankingService": {}, "CreateAssetRequestBody": { "title": "CreateAssetRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateAssetRequestBody', exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "legalName": { "type": "string", "nullable": false }, "securityType": { "type": "string", "nullable": false }, "purchaseAgreementId": { "type": "string", "nullable": true }, "wireInstructionsId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": false }, "industry": { "type": "string", "nullable": true }, "portfolioCompanyContact": { "type": "string", "nullable": true }, "portfolioCompanyPhone": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "valuation": { "type": "number", "nullable": true }, "valuationDate": { "type": "string", "format": "date-time", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "conversionTarget": { "type": "string", "nullable": true, "enum": [ "equity", "tokens", "both", "tbd" ] }, "conversionTrigger": { "type": "string", "nullable": true, "enum": [ "priced_round", "token_launch", "liquidity_event", "other" ] }, "hasTokenLinkedPayout": { "type": "boolean", "nullable": true }, "fundManagerLegalName": { "type": "string", "nullable": true }, "issuerLegalName": { "type": "string", "nullable": true }, "borrowerLegalName": { "type": "string", "nullable": true }, "stockCompanyLegalName": { "type": "string", "nullable": true }, "otherLegalName": { "type": "string", "nullable": true }, "fundManagerJurisdiction": { "type": "string", "nullable": true }, "borrowerJurisdiction": { "type": "string", "nullable": true }, "otherJurisdiction": { "type": "string", "nullable": true }, "otherTypeDescription": { "type": "string", "nullable": true }, "otherRegulatedActivities": { "type": "boolean", "nullable": true }, "noteSecurity": { "type": "string", "nullable": true }, "debtRepayment": { "type": "string", "nullable": true }, "fundStrategy": { "type": "string", "nullable": true }, "hasDigitalAssetExposure": { "type": "boolean", "nullable": true }, "stockBlockchainProducts": { "type": "boolean", "nullable": true }, "stockRegulatedActivities": { "type": "boolean", "nullable": true }, "digitalAssetExposureDescription": { "type": "string", "nullable": true }, "isVaspRegistered": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdateAssetRequestBody": { "title": "UpdateAssetRequestBody", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>, schemaOptions: { title: 'UpdateAssetRequestBody', partial: true, exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "legalName": { "type": "string", "nullable": false }, "securityType": { "type": "string", "nullable": false }, "purchaseAgreementId": { "type": "string", "nullable": true }, "wireInstructionsId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": false }, "industry": { "type": "string", "nullable": true }, "portfolioCompanyContact": { "type": "string", "nullable": true }, "portfolioCompanyPhone": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "valuation": { "type": "number", "nullable": true }, "valuationDate": { "type": "string", "format": "date-time", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "conversionTarget": { "type": "string", "nullable": true, "enum": [ "equity", "tokens", "both", "tbd" ] }, "conversionTrigger": { "type": "string", "nullable": true, "enum": [ "priced_round", "token_launch", "liquidity_event", "other" ] }, "hasTokenLinkedPayout": { "type": "boolean", "nullable": true }, "fundManagerLegalName": { "type": "string", "nullable": true }, "issuerLegalName": { "type": "string", "nullable": true }, "borrowerLegalName": { "type": "string", "nullable": true }, "stockCompanyLegalName": { "type": "string", "nullable": true }, "otherLegalName": { "type": "string", "nullable": true }, "fundManagerJurisdiction": { "type": "string", "nullable": true }, "borrowerJurisdiction": { "type": "string", "nullable": true }, "otherJurisdiction": { "type": "string", "nullable": true }, "otherTypeDescription": { "type": "string", "nullable": true }, "otherRegulatedActivities": { "type": "boolean", "nullable": true }, "noteSecurity": { "type": "string", "nullable": true }, "debtRepayment": { "type": "string", "nullable": true }, "fundStrategy": { "type": "string", "nullable": true }, "hasDigitalAssetExposure": { "type": "boolean", "nullable": true }, "stockBlockchainProducts": { "type": "boolean", "nullable": true }, "stockRegulatedActivities": { "type": "boolean", "nullable": true }, "digitalAssetExposureDescription": { "type": "string", "nullable": true }, "isVaspRegistered": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>" }, "Announcements": { "title": "Announcements", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "slug": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "title": { "type": "string", "nullable": true }, "classes": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CreateAnnouncementRequestBody": { "title": "CreateAnnouncementRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'CreateAnnouncementRequestBody', exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "slug": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "title": { "type": "string", "nullable": true }, "classes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdateAnnouncementRequestBody": { "title": "UpdateAnnouncementRequestBody", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>, schemaOptions: { title: 'UpdateAnnouncementRequestBody', partial: true, exclude: [ 'id', 'createdAt', 'updatedAt', 'deleted', 'deletedOn', 'deletedBy' ] })", "properties": { "slug": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "title": { "type": "string", "nullable": true }, "classes": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'updatedAt' | 'deleted' | 'deletedOn' | 'deletedBy'>" }, "CreateAccreditationRequestBody": { "title": "CreateAccreditationRequestBody", "type": "object", "description": "(tsType: Omit, schemaOptions: {\n title: 'CreateAccreditationRequestBody',\n exclude: [\n 'id', 'createdAt',\n 'updatedAt', 'deletedBy',\n 'deleted', 'deletedOn',\n 'userEmail', 'userId'\n ]\n})", "properties": { "type": { "type": "string", "nullable": true }, "user_investment_entity_id": { "type": "string", "nullable": true, "format": "uuid" }, "description": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "identitiesId": { "type": "string", "nullable": true, "format": "uuid" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UpdateAccreditationRequestBody": { "title": "UpdateAccreditationRequestBody", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'updatedAt' | 'deletedBy' | 'deleted' | 'deletedOn' | 'userEmail'>, schemaOptions: { title: 'UpdateAccreditationRequestBody', partial: true, exclude: [ 'id', 'createdAt', 'updatedAt', 'deletedBy', 'deleted', 'deletedOn', 'userEmail' ] })", "properties": { "type": { "type": "string", "nullable": true }, "user_investment_entity_id": { "type": "string", "nullable": true, "format": "uuid" }, "description": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "identitiesId": { "type": "string", "nullable": true, "format": "uuid" }, "userId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'updatedAt' | 'deletedBy' | 'deleted' | 'deletedOn' | 'userEmail'>" }, "Accreditations": { "title": "Accreditations", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "user_investment_entity_id": { "type": "string", "nullable": true, "format": "uuid" }, "description": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "identitiesId": { "type": "string", "nullable": true, "format": "uuid" }, "userId": { "type": "string" } }, "additionalProperties": false }, "LedgerWithRelations": { "title": "Ledger", "type": "object", "description": "(tsType: Ledger, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "amount": { "type": "number", "nullable": false }, "debit": { "type": "boolean", "nullable": false }, "categoriesId": { "type": "string", "nullable": false }, "description": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true }, "entryDate": { "type": "string", "nullable": false }, "newLedgerEntryId": { "type": "string", "nullable": true } }, "required": [ "createdAt" ], "additionalProperties": false, "x-typescript-type": "Ledger" }, "LedgerCategoriesWithRelations": { "title": "LedgerCategoriesWithRelations", "type": "object", "description": "(tsType: LedgerCategoriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "name": { "type": "string", "nullable": false }, "code": { "type": "string", "nullable": false }, "type": { "type": "string", "nullable": false } }, "additionalProperties": false, "x-typescript-type": "LedgerCategoriesWithRelations" }, "EntitiesTaxesMetadataWithRelations": { "title": "EntitiesTaxesMetadata", "type": "object", "description": "(tsType: EntitiesTaxesMetadata, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "entityId": { "type": "string" }, "taxYear": { "type": "string", "nullable": false }, "providerLocked": { "type": "boolean", "nullable": true }, "irsSubmissionId": { "type": "string", "nullable": true }, "irsSubmissionStatus": { "type": "string", "nullable": true }, "irsSubmissionDate": { "type": "string", "format": "date-time", "nullable": true }, "irsAcceptedDate": { "type": "string", "format": "date-time", "nullable": true }, "irsExtensionId": { "type": "string", "nullable": true }, "irsExtensionStatus": { "type": "string", "nullable": true }, "irsExtensionDate": { "type": "string", "format": "date-time", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "detectedDiscrepancies": { "type": "array", "items": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "type": { "type": "string" }, "detail": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string", "format": "date-time" } } } } }, "discrepancyDiff": { "type": "array", "items": { "type": "object", "nullable": true } }, "latestDiscrepancyCheck": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "EntitiesTaxesMetadata" }, "OrganizationsRolesWithRelations": { "title": "OrganizationsRolesWithRelations", "type": "object", "description": "(tsType: OrganizationsRolesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "type": { "type": "string" }, "userId": { "type": "string" }, "isInvite": { "type": "boolean" }, "organizationId": { "type": "string" }, "userEmail": { "type": "string" }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UsersWithRelations" } }, "required": [ "type", "userId", "isInvite" ], "additionalProperties": false, "definitions": { "InvestmentsWithRelations": { "title": "InvestmentsWithRelations", "type": "object", "description": "(tsType: InvestmentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "blueskyFees": { "type": "number", "nullable": true }, "capitalWiredAmount": { "type": "number" }, "carry": { "type": "number", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "managementFeesDollars": { "type": "number", "nullable": true }, "netInvestment": { "type": "number", "nullable": true }, "otherExpenses": { "type": "number", "nullable": true }, "privateFundExpenses": { "type": "number", "nullable": true }, "spvFees": { "type": "number", "nullable": true }, "subscriptionAmount": { "type": "number", "nullable": true }, "completeAt": { "type": "string", "format": "date-time", "nullable": true }, "ledgerMatched": { "type": "boolean", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoInvestmentId": { "type": "string", "nullable": true }, "mongoUserId": { "type": "string", "nullable": true }, "invitedAtLegacy": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "manualEntryWireDate": { "type": "string", "format": "date-time", "nullable": true }, "source": { "type": "string", "nullable": true }, "invitedAt": { "type": "string", "format": "date-time", "nullable": true }, "wiredDate": { "type": "string", "format": "date-time", "nullable": true }, "distributionAssetType": { "type": "string", "nullable": true, "enum": [ "Cash", "Stock", "USDT", "USDC" ] }, "distributionTransferInfoId": { "type": "string", "format": "uuid" }, "identitiesId": { "type": "string" }, "dealId": { "type": "string" }, "userId": { "type": "string" }, "distributionTransferInformation": { "$ref": "#/components/schemas/TransferInformationWithRelations" }, "foreignKey": {}, "identity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "investmentsTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTaxesWithRelations" } }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FilesWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTransferInformationWithRelations" } } }, "required": [ "userId" ], "additionalProperties": false, "x-typescript-type": "InvestmentsWithRelations" }, "EntitiesTaxesMetadataWithRelations": { "title": "EntitiesTaxesMetadataWithRelations", "type": "object", "description": "(tsType: EntitiesTaxesMetadataWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "entityId": { "type": "string" }, "taxYear": { "type": "string", "nullable": false }, "providerLocked": { "type": "boolean", "nullable": true }, "irsSubmissionId": { "type": "string", "nullable": true }, "irsSubmissionStatus": { "type": "string", "nullable": true }, "irsSubmissionDate": { "type": "string", "format": "date-time", "nullable": true }, "irsAcceptedDate": { "type": "string", "format": "date-time", "nullable": true }, "irsExtensionId": { "type": "string", "nullable": true }, "irsExtensionStatus": { "type": "string", "nullable": true }, "irsExtensionDate": { "type": "string", "format": "date-time", "nullable": true }, "filingStatus": { "type": "string", "nullable": true }, "detectedDiscrepancies": { "type": "array", "items": { "type": "array", "nullable": true, "items": { "type": "object", "properties": { "type": { "type": "string" }, "detail": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } }, "date": { "type": "string", "format": "date-time" } } } } }, "discrepancyDiff": { "type": "array", "items": { "type": "object", "nullable": true } }, "latestDiscrepancyCheck": { "type": "string", "format": "date-time", "nullable": true }, "entities": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "EntitiesTaxesMetadataWithRelations" }, "EntitiesWithRelations": { "title": "EntitiesWithRelations", "type": "object", "description": "(tsType: EntitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "formationDate": { "type": "string", "format": "date-time", "nullable": true }, "streetAddress": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "entityType": { "type": "string", "nullable": true }, "organizationName": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "ein": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "fundManager": { "type": "string", "nullable": true }, "taxStatus": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "returnId": { "type": "string", "nullable": true }, "taxesProvider": { "type": "string", "nullable": true }, "taxesProviderId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "partnershipRepresentativeId": { "type": "string", "nullable": true }, "partnershipRepresentativeDesignatedIndividualId": { "type": "string", "nullable": true }, "parentEntityId": { "type": "string", "nullable": true }, "organizationId": { "type": "string", "nullable": true }, "deals": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } }, "entitiesTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesTaxesWithRelations" } }, "investmentsTaxes": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsTaxesWithRelations" } }, "legacyLedgers": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerWithRelations" } }, "ledger": { "$ref": "#/components/schemas/LedgersWithRelations" }, "partnershipRepresentative": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "partnershipRepresentativeDesignatedIndividual": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "parentEntity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "entitiesTaxesMetadata": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesTaxesMetadataWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "EntitiesWithRelations" }, "InvestmentsTaxesWithRelations": { "title": "InvestmentsTaxesWithRelations", "type": "object", "description": "(tsType: InvestmentsTaxesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": true }, "taxYear": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "investorIdentitiesId": { "type": "string", "nullable": true }, "investorLegalName": { "type": "string", "nullable": true }, "investorTaxId": { "type": "string", "nullable": true }, "investorStreetAddress": { "type": "string", "nullable": true }, "investorCity": { "type": "string", "nullable": true }, "investorState": { "type": "string", "nullable": true }, "investorPostalCode": { "type": "string", "nullable": true }, "investorIsUsDomestic": { "type": "boolean", "nullable": true }, "investorFcAndSoiAndDApplicable": { "type": "boolean", "nullable": true }, "investorOtherDeductions": { "type": "number", "nullable": true }, "investorContributions": { "type": "number", "default": 0 }, "investorDistributions": { "type": "number", "nullable": true }, "dealId": { "type": "string", "nullable": true }, "investorEntityType": { "type": "string", "nullable": true }, "investorEntityIsDisregarded": { "type": "boolean", "default": false }, "investorDisregardedOwnerName": { "type": "string", "nullable": true }, "investorDisregardedOwnerTaxId": { "type": "string", "nullable": true }, "investorBeginningProfitPercentage": { "type": "number", "default": 0 }, "investorBeginningLossPercentage": { "type": "number", "default": 0 }, "investorBeginningCapitalPercentage": { "type": "number", "default": 0 }, "investorForeignTaxCreditLimitationApplicable": { "type": "boolean", "nullable": true, "default": false }, "investorCountry": { "type": "string", "nullable": true }, "investorEndingProfitPercentage": { "type": "number", "default": 0 }, "investorEndingLossPercentage": { "type": "number", "default": 0 }, "investorEndingCapitalPercentage": { "type": "number", "default": 0 }, "k1FilesId": { "type": "string", "nullable": true }, "investorOwnershipPercent": { "type": "number", "default": 0 }, "investorCurrentYearNetIncomeLoss": { "type": "number", "default": 0 }, "investorEndingCapitalAccountAmount": { "type": "number", "default": 0 }, "investorBeginningCapitalAccountAmount": { "type": "number", "default": 0 }, "legacyRecordId": { "type": "string", "nullable": true }, "calculatorVersion": { "type": "string", "nullable": true }, "partnerIndex": { "type": "number", "nullable": true }, "investorEmail": { "type": "string", "nullable": true }, "lastPrintedAt": { "type": "string", "format": "date-time", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "investmentId": { "type": "string" }, "entityId": { "type": "string" }, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "foreignKey": {}, "entities": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "InvestmentsTaxesWithRelations" }, "FilesWithRelations": { "title": "FilesWithRelations", "type": "object", "description": "(tsType: FilesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "key": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "mongoOwnerId": { "type": "string", "nullable": true }, "legacyBucket": { "type": "string", "nullable": true }, "legacyKey": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "mongoDocumentsId": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "bucket": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "FilesWithRelations" }, "InvestmentsTransferInformationWithRelations": { "title": "InvestmentsTransferInformationWithRelations", "type": "object", "description": "(tsType: InvestmentsTransferInformationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "investmentId": { "type": "string", "nullable": true }, "transferInformationId": { "type": "string", "nullable": false }, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "InvestmentsTransferInformationWithRelations" }, "IdentitiesWithRelations": { "title": "IdentitiesWithRelations", "type": "object", "description": "(tsType: IdentitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": false, "enum": [ "Individual", "Entity" ] }, "entityType": { "type": "string", "nullable": true, "enum": [ "Entity", "LLC", "Corporation", "Partnership", "Joint", "IRA", "Trust" ] }, "taxId": { "type": "string", "nullable": true }, "taxIdType": { "type": "string", "nullable": true }, "addressLine_1": { "type": "string", "nullable": true }, "addressLine_2": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "usDomestic": { "type": "boolean", "nullable": true }, "entityIsDisregarded": { "type": "boolean", "nullable": true }, "ownershipPercent": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "parentIdentityId": { "type": "string", "nullable": true }, "provider": { "type": "string", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "dateOfEntityFormation": { "type": "string", "format": "date-time", "nullable": true }, "legalName": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "archived": { "type": "boolean", "nullable": true }, "countryOfCitizenship": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": false, "enum": [ "in_review", "failed", "success", "queued", "archived", "error", "pending" ] }, "isMigration": { "type": "boolean", "nullable": true }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "kycChecks": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityKycChecksWithRelations" } }, "identityFiles": { "type": "array", "items": { "$ref": "#/components/schemas/IdentityFilesWithRelations" } }, "relations": { "type": "array", "items": { "$ref": "#/components/schemas/IdentitiesRelationsWithRelations" } }, "accreditations": { "type": "array", "items": { "$ref": "#/components/schemas/AccreditationsWithRelations" } }, "transferInformation": { "type": "array", "items": { "$ref": "#/components/schemas/TransferInformationWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "IdentitiesWithRelations" }, "AssetsWithRelations": { "title": "AssetsWithRelations", "type": "object", "description": "(tsType: AssetsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "legalName": { "type": "string", "nullable": false }, "securityType": { "type": "string", "nullable": false }, "purchaseAgreementId": { "type": "string", "nullable": true }, "wireInstructionsId": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "location": { "type": "string", "nullable": false }, "industry": { "type": "string", "nullable": true }, "portfolioCompanyContact": { "type": "string", "nullable": true }, "portfolioCompanyPhone": { "type": "string", "nullable": true }, "companyWebsite": { "type": "string", "nullable": true }, "valuation": { "type": "number", "nullable": true }, "valuationDate": { "type": "string", "format": "date-time", "nullable": true }, "dealId": { "type": "string", "nullable": false }, "conversionTarget": { "type": "string", "nullable": true, "enum": [ "equity", "tokens", "both", "tbd" ] }, "conversionTrigger": { "type": "string", "nullable": true, "enum": [ "priced_round", "token_launch", "liquidity_event", "other" ] }, "hasTokenLinkedPayout": { "type": "boolean", "nullable": true }, "fundManagerLegalName": { "type": "string", "nullable": true }, "issuerLegalName": { "type": "string", "nullable": true }, "borrowerLegalName": { "type": "string", "nullable": true }, "stockCompanyLegalName": { "type": "string", "nullable": true }, "otherLegalName": { "type": "string", "nullable": true }, "fundManagerJurisdiction": { "type": "string", "nullable": true }, "borrowerJurisdiction": { "type": "string", "nullable": true }, "otherJurisdiction": { "type": "string", "nullable": true }, "otherTypeDescription": { "type": "string", "nullable": true }, "otherRegulatedActivities": { "type": "boolean", "nullable": true }, "noteSecurity": { "type": "string", "nullable": true }, "debtRepayment": { "type": "string", "nullable": true }, "fundStrategy": { "type": "string", "nullable": true }, "hasDigitalAssetExposure": { "type": "boolean", "nullable": true }, "stockBlockchainProducts": { "type": "boolean", "nullable": true }, "stockRegulatedActivities": { "type": "boolean", "nullable": true }, "digitalAssetExposureDescription": { "type": "string", "nullable": true }, "isVaspRegistered": { "type": "boolean", "nullable": true }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "AssetsWithRelations" }, "ClosesWithRelations": { "title": "ClosesWithRelations", "type": "object", "description": "(tsType: ClosesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "requestedCloseDate": { "type": "string", "format": "date-time", "nullable": true }, "organizationsId": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "portfolioWireAmount": { "type": "number", "nullable": true }, "requestedCloseAmount": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "sheetUri": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "dealsId": { "type": "string", "nullable": true }, "entitiesId": { "type": "string", "nullable": true }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {}, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "ClosesWithRelations" }, "InvitationsWithRelations": { "title": "InvitationsWithRelations", "type": "object", "description": "(tsType: InvitationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "recipientEmail": { "type": "string" }, "dealId": { "type": "string", "nullable": false }, "amount": { "type": "number" }, "type": { "type": "string" }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {} }, "required": [ "recipientEmail", "dealId", "amount" ], "additionalProperties": false, "x-typescript-type": "InvitationsWithRelations" }, "DealDetailsWithRelations": { "title": "DealDetailsWithRelations", "type": "object", "description": "(tsType: DealDetailsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "dealId": { "type": "string" }, "acceptCrypto": { "type": "boolean", "nullable": true }, "advisorType": { "type": "string", "nullable": true }, "assetId": { "type": "string", "nullable": true }, "bankAccountId": { "type": "string", "nullable": true }, "bankingProvider": { "type": "string", "nullable": true }, "dealTerm": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "entityName": { "type": "string", "nullable": true }, "estimatedMultiple": { "type": "number", "nullable": true }, "estimatedAssetCount": { "type": "number", "nullable": true }, "internationalInvestors": { "type": "boolean", "nullable": true }, "hasAccreditedInvestors": { "type": "boolean", "nullable": true }, "hasQualifiedPurchasers": { "type": "boolean", "nullable": true }, "hasInstitutionalInvestors": { "type": "boolean", "nullable": true }, "internationalTransactionsExpected": { "type": "boolean", "nullable": true }, "nonUsFinancialInstitutions": { "type": "boolean", "nullable": true }, "legacyCompanyName": { "type": "string", "nullable": true }, "legalTemplateOption": { "type": "string", "nullable": true }, "masterSeries": { "type": "string", "nullable": true }, "onboardingLink": { "type": "string", "nullable": true }, "seriesName": { "type": "string", "nullable": true }, "subType": { "type": "string", "nullable": true }, "agreeMsa": { "type": "boolean", "nullable": true }, "agreeCosts": { "type": "boolean", "nullable": true }, "agreeSetup": { "type": "boolean", "nullable": true }, "masterSeriesId": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "advisorTypeNote": { "type": "string", "nullable": true }, "bankingProviderNote": { "type": "string", "nullable": true }, "fundManagerEmail": { "type": "string", "nullable": true }, "financialStatementFrequency": { "type": "string", "nullable": true }, "deal": { "$ref": "#/components/schemas/DealsWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "DealDetailsWithRelations" }, "DealsWithRelations": { "title": "DealsWithRelations", "type": "object", "description": "(tsType: DealsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "minimumInvestment": { "type": "number", "nullable": true }, "closingDate": { "type": "string", "format": "date-time", "nullable": true }, "offeringType": { "type": "string", "nullable": true }, "managementFeeFrequency": { "type": "string", "nullable": true }, "managementFeePercent": { "type": "number", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "userId": { "type": "string", "nullable": true }, "mongoDealId": { "type": "string", "nullable": true }, "mongoOrganizationId": { "type": "string", "nullable": true }, "isMigration": { "type": "boolean", "nullable": true }, "targetRaiseGoal": { "type": "number", "nullable": true }, "totalCarry": { "type": "number", "nullable": true }, "slug": { "type": "string", "nullable": true }, "memo": { "type": "string", "nullable": true }, "documentsTemplateId": { "type": "string", "nullable": true }, "documentsProvider": { "type": "string", "nullable": true }, "shortcodeId": { "type": "string", "nullable": true }, "totalCarryNotes": { "type": "string", "nullable": true }, "managementFeeNotes": { "type": "string", "nullable": true }, "closedDate": { "type": "string", "format": "date-time", "nullable": true }, "tags": { "type": "string", "nullable": true }, "migrationApproval": { "type": "boolean", "nullable": true }, "migrationApprovalDate": { "type": "string", "nullable": true }, "migrationApprovalEmail": { "type": "string", "nullable": true }, "migrationFmSent": { "type": "boolean", "nullable": true }, "invoiceAmount": { "type": "number", "nullable": true }, "invoiceNumber": { "type": "string", "nullable": true }, "invoiceStatus": { "type": "string", "nullable": true }, "capitalAccountStatementURI": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time", "nullable": true }, "advisorStatus": { "type": "string", "nullable": true }, "entityId": { "type": "string" }, "fmIdentityId": { "type": "string" }, "advisorId": { "type": "string", "nullable": true }, "organizationId": { "type": "string" }, "investments": { "type": "array", "items": { "$ref": "#/components/schemas/InvestmentsWithRelations" } }, "entity": { "$ref": "#/components/schemas/EntitiesWithRelations" }, "foreignKey": {}, "fmIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "advisorIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "closes": { "type": "array", "items": { "$ref": "#/components/schemas/ClosesWithRelations" } }, "organization": { "$ref": "#/components/schemas/OrganizationsWithRelations" }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/AssetsWithRelations" } }, "invitations": { "type": "array", "items": { "$ref": "#/components/schemas/InvitationsWithRelations" } }, "dealDetails": { "$ref": "#/components/schemas/DealDetailsWithRelations" }, "files": { "type": "array", "items": { "$ref": "#/components/schemas/FilesWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "DealsWithRelations" }, "OrganizationsWithRelations": { "title": "OrganizationsWithRelations", "type": "object", "description": "(tsType: OrganizationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "status": { "type": "string", "nullable": true }, "mongoId": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "slug": { "type": "string", "nullable": true }, "approved": { "type": "string", "nullable": true }, "highVolumePartner": { "type": "boolean", "nullable": true }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "string", "nullable": true }, "mouSigned": { "type": "boolean", "nullable": true }, "userEmail": { "type": "string", "nullable": true }, "phase": { "type": "string", "nullable": true }, "addressLine1": { "type": "string", "nullable": true }, "addressLine2": { "type": "string", "nullable": true }, "postalCode": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "isArchived": { "type": "boolean", "nullable": true }, "tags": { "type": "string", "nullable": true }, "representativeIdentityId": { "type": "string", "nullable": true }, "representativeIndividualIdentityId": { "type": "string", "nullable": true }, "deals": { "type": "array", "items": { "$ref": "#/components/schemas/DealsWithRelations" } }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EntitiesWithRelations" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationsRolesWithRelations" } }, "representativeIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" }, "foreignKey": {}, "representativeIndividualIdentity": { "$ref": "#/components/schemas/IdentitiesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "OrganizationsWithRelations" }, "UsersWithRelations": { "title": "UsersWithRelations", "type": "object", "description": "(tsType: UsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "mongoId": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": false }, "firstName": { "type": "string", "nullable": true }, "investorType": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "isSuperAdmin": { "type": "boolean", "nullable": false, "default": false }, "isMigration": { "type": "boolean", "nullable": true }, "birthdate": { "type": "string", "format": "date-time", "nullable": true }, "citizenshipCountry": { "type": "string", "nullable": true }, "taxId": { "type": "string", "nullable": true } }, "required": [ "email" ], "additionalProperties": false, "x-typescript-type": "UsersWithRelations" } }, "x-typescript-type": "OrganizationsRolesWithRelations" }, "TransactionsWithRelations": { "title": "TransactionsWithRelations", "type": "object", "description": "(tsType: TransactionsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "amount": { "type": "number", "nullable": false }, "status": { "type": "string", "nullable": true }, "providerData": { "type": "object", "nullable": true }, "providerId": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "authorizedAt": { "type": "string", "format": "date-time", "nullable": false }, "postedAt": { "type": "string", "format": "date-time", "nullable": false }, "investmentId": { "type": "string", "nullable": true }, "bankAccountId": { "type": "string", "nullable": false }, "investment": { "$ref": "#/components/schemas/InvestmentsWithRelations" }, "foreignKey": {}, "bankAccount": { "$ref": "#/components/schemas/BankAccountsWithRelations" } }, "additionalProperties": false, "x-typescript-type": "TransactionsWithRelations" }, "LedgerEntryRelationshipsWithRelations": { "title": "LedgerEntryRelationshipsWithRelations", "type": "object", "description": "(tsType: LedgerEntryRelationshipsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "entryId": { "type": "string", "nullable": false }, "relatedEntryId": { "type": "string", "nullable": false }, "entry": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" }, "foreignKey": {}, "relatedEntry": { "$ref": "#/components/schemas/LedgerEntriesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "LedgerEntryRelationshipsWithRelations" }, "closes.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "closes.ScopeFilter" }, "closes.IncludeFilter.Items": { "title": "closes.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "investments", "deal", "entity", "assets" ] }, "scope": { "$ref": "#/components/schemas/closes.ScopeFilter" } } }, "closes.Filter": { "type": "object", "title": "closes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "closedDate": { "type": "boolean" }, "requestedCloseDate": { "type": "boolean" }, "organizationsId": { "type": "boolean" }, "userId": { "type": "boolean" }, "portfolioWireAmount": { "type": "boolean" }, "requestedCloseAmount": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "sheetUri": { "type": "boolean" }, "status": { "type": "boolean" }, "dealsId": { "type": "boolean" }, "entitiesId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "closedDate", "requestedCloseDate", "organizationsId", "userId", "portfolioWireAmount", "requestedCloseAmount", "userEmail", "sheetUri", "status", "dealsId", "entitiesId" ], "example": "id" }, "uniqueItems": true } ], "title": "closes.Fields" }, "include": { "title": "closes.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/closes.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "closes.Filter1": { "type": "object", "title": "closes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "closes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "closedDate": { "type": "boolean" }, "requestedCloseDate": { "type": "boolean" }, "organizationsId": { "type": "boolean" }, "userId": { "type": "boolean" }, "portfolioWireAmount": { "type": "boolean" }, "requestedCloseAmount": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "sheetUri": { "type": "boolean" }, "status": { "type": "boolean" }, "dealsId": { "type": "boolean" }, "entitiesId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "closedDate", "requestedCloseDate", "organizationsId", "userId", "portfolioWireAmount", "requestedCloseAmount", "userEmail", "sheetUri", "status", "dealsId", "entitiesId" ], "example": "id" }, "uniqueItems": true } ], "title": "closes.Fields" }, "include": { "title": "closes.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/closes.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "SecondaryRequests.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "SecondaryRequests.ScopeFilter" }, "SecondaryRequests.IncludeFilter.Items": { "title": "SecondaryRequests.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal", "user" ] }, "scope": { "$ref": "#/components/schemas/SecondaryRequests.ScopeFilter" } } }, "SecondaryRequests.Filter": { "type": "object", "title": "SecondaryRequests.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "SecondaryRequests.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "dealId": { "type": "boolean" }, "userId": { "type": "boolean" }, "amount": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "dealId", "userId", "amount", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "SecondaryRequests.Fields" }, "include": { "title": "SecondaryRequests.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SecondaryRequests.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Deals.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Deals.ScopeFilter" }, "Deals.IncludeFilter.Items": { "title": "Deals.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "investments", "entity", "fmIdentity", "advisorIdentity", "closes", "organization", "assets", "invitations", "dealDetails", "files" ] }, "scope": { "$ref": "#/components/schemas/Deals.ScopeFilter" } } }, "Deals.Filter": { "type": "object", "title": "Deals.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Deals.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "name": { "type": "boolean" }, "type": { "type": "boolean" }, "status": { "type": "boolean" }, "minimumInvestment": { "type": "boolean" }, "closingDate": { "type": "boolean" }, "offeringType": { "type": "boolean" }, "managementFeeFrequency": { "type": "boolean" }, "managementFeePercent": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "mongoOrganizationId": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "targetRaiseGoal": { "type": "boolean" }, "totalCarry": { "type": "boolean" }, "slug": { "type": "boolean" }, "memo": { "type": "boolean" }, "documentsTemplateId": { "type": "boolean" }, "documentsProvider": { "type": "boolean" }, "shortcodeId": { "type": "boolean" }, "totalCarryNotes": { "type": "boolean" }, "managementFeeNotes": { "type": "boolean" }, "closedDate": { "type": "boolean" }, "tags": { "type": "boolean" }, "migrationApproval": { "type": "boolean" }, "migrationApprovalDate": { "type": "boolean" }, "migrationApprovalEmail": { "type": "boolean" }, "migrationFmSent": { "type": "boolean" }, "invoiceAmount": { "type": "boolean" }, "invoiceNumber": { "type": "boolean" }, "invoiceStatus": { "type": "boolean" }, "capitalAccountStatementURI": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "advisorStatus": { "type": "boolean" }, "entityId": { "type": "boolean" }, "fmIdentityId": { "type": "boolean" }, "advisorId": { "type": "boolean" }, "organizationId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "name", "type", "status", "minimumInvestment", "closingDate", "offeringType", "managementFeeFrequency", "managementFeePercent", "userEmail", "userId", "mongoDealId", "mongoOrganizationId", "isMigration", "targetRaiseGoal", "totalCarry", "slug", "memo", "documentsTemplateId", "documentsProvider", "shortcodeId", "totalCarryNotes", "managementFeeNotes", "closedDate", "tags", "migrationApproval", "migrationApprovalDate", "migrationApprovalEmail", "migrationFmSent", "invoiceAmount", "invoiceNumber", "invoiceStatus", "capitalAccountStatementURI", "phoneNumber", "invoiceDate", "advisorStatus", "entityId", "fmIdentityId", "advisorId", "organizationId" ], "example": "id" }, "uniqueItems": true } ], "title": "Deals.Fields" }, "include": { "title": "Deals.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Deals.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Assets.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Assets.ScopeFilter" }, "Assets.IncludeFilter.Items": { "title": "Assets.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal" ] }, "scope": { "$ref": "#/components/schemas/Assets.ScopeFilter" } } }, "Assets.Filter": { "type": "object", "title": "Assets.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "legalName": { "type": "boolean" }, "securityType": { "type": "boolean" }, "purchaseAgreementId": { "type": "boolean" }, "wireInstructionsId": { "type": "boolean" }, "type": { "type": "boolean" }, "location": { "type": "boolean" }, "industry": { "type": "boolean" }, "portfolioCompanyContact": { "type": "boolean" }, "portfolioCompanyPhone": { "type": "boolean" }, "companyWebsite": { "type": "boolean" }, "valuation": { "type": "boolean" }, "valuationDate": { "type": "boolean" }, "dealId": { "type": "boolean" }, "conversionTarget": { "type": "boolean" }, "conversionTrigger": { "type": "boolean" }, "hasTokenLinkedPayout": { "type": "boolean" }, "fundManagerLegalName": { "type": "boolean" }, "issuerLegalName": { "type": "boolean" }, "borrowerLegalName": { "type": "boolean" }, "stockCompanyLegalName": { "type": "boolean" }, "otherLegalName": { "type": "boolean" }, "fundManagerJurisdiction": { "type": "boolean" }, "borrowerJurisdiction": { "type": "boolean" }, "otherJurisdiction": { "type": "boolean" }, "otherTypeDescription": { "type": "boolean" }, "otherRegulatedActivities": { "type": "boolean" }, "noteSecurity": { "type": "boolean" }, "debtRepayment": { "type": "boolean" }, "fundStrategy": { "type": "boolean" }, "hasDigitalAssetExposure": { "type": "boolean" }, "stockBlockchainProducts": { "type": "boolean" }, "stockRegulatedActivities": { "type": "boolean" }, "digitalAssetExposureDescription": { "type": "boolean" }, "isVaspRegistered": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "legalName", "securityType", "purchaseAgreementId", "wireInstructionsId", "type", "location", "industry", "portfolioCompanyContact", "portfolioCompanyPhone", "companyWebsite", "valuation", "valuationDate", "dealId", "conversionTarget", "conversionTrigger", "hasTokenLinkedPayout", "fundManagerLegalName", "issuerLegalName", "borrowerLegalName", "stockCompanyLegalName", "otherLegalName", "fundManagerJurisdiction", "borrowerJurisdiction", "otherJurisdiction", "otherTypeDescription", "otherRegulatedActivities", "noteSecurity", "debtRepayment", "fundStrategy", "hasDigitalAssetExposure", "stockBlockchainProducts", "stockRegulatedActivities", "digitalAssetExposureDescription", "isVaspRegistered" ], "example": "id" }, "uniqueItems": true } ], "title": "Assets.Fields" }, "include": { "title": "Assets.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Assets.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Assets.Filter1": { "type": "object", "title": "Assets.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Assets.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "legalName": { "type": "boolean" }, "securityType": { "type": "boolean" }, "purchaseAgreementId": { "type": "boolean" }, "wireInstructionsId": { "type": "boolean" }, "type": { "type": "boolean" }, "location": { "type": "boolean" }, "industry": { "type": "boolean" }, "portfolioCompanyContact": { "type": "boolean" }, "portfolioCompanyPhone": { "type": "boolean" }, "companyWebsite": { "type": "boolean" }, "valuation": { "type": "boolean" }, "valuationDate": { "type": "boolean" }, "dealId": { "type": "boolean" }, "conversionTarget": { "type": "boolean" }, "conversionTrigger": { "type": "boolean" }, "hasTokenLinkedPayout": { "type": "boolean" }, "fundManagerLegalName": { "type": "boolean" }, "issuerLegalName": { "type": "boolean" }, "borrowerLegalName": { "type": "boolean" }, "stockCompanyLegalName": { "type": "boolean" }, "otherLegalName": { "type": "boolean" }, "fundManagerJurisdiction": { "type": "boolean" }, "borrowerJurisdiction": { "type": "boolean" }, "otherJurisdiction": { "type": "boolean" }, "otherTypeDescription": { "type": "boolean" }, "otherRegulatedActivities": { "type": "boolean" }, "noteSecurity": { "type": "boolean" }, "debtRepayment": { "type": "boolean" }, "fundStrategy": { "type": "boolean" }, "hasDigitalAssetExposure": { "type": "boolean" }, "stockBlockchainProducts": { "type": "boolean" }, "stockRegulatedActivities": { "type": "boolean" }, "digitalAssetExposureDescription": { "type": "boolean" }, "isVaspRegistered": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "legalName", "securityType", "purchaseAgreementId", "wireInstructionsId", "type", "location", "industry", "portfolioCompanyContact", "portfolioCompanyPhone", "companyWebsite", "valuation", "valuationDate", "dealId", "conversionTarget", "conversionTrigger", "hasTokenLinkedPayout", "fundManagerLegalName", "issuerLegalName", "borrowerLegalName", "stockCompanyLegalName", "otherLegalName", "fundManagerJurisdiction", "borrowerJurisdiction", "otherJurisdiction", "otherTypeDescription", "otherRegulatedActivities", "noteSecurity", "debtRepayment", "fundStrategy", "hasDigitalAssetExposure", "stockBlockchainProducts", "stockRegulatedActivities", "digitalAssetExposureDescription", "isVaspRegistered" ], "example": "id" }, "uniqueItems": true } ], "title": "Assets.Fields" }, "include": { "title": "Assets.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Assets.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DealDetails.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "DealDetails.ScopeFilter" }, "DealDetails.IncludeFilter.Items": { "title": "DealDetails.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal" ] }, "scope": { "$ref": "#/components/schemas/DealDetails.ScopeFilter" } } }, "DealDetails.Filter": { "type": "object", "title": "DealDetails.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "dealId": { "type": "boolean" }, "acceptCrypto": { "type": "boolean" }, "advisorType": { "type": "boolean" }, "assetId": { "type": "boolean" }, "bankAccountId": { "type": "boolean" }, "bankingProvider": { "type": "boolean" }, "dealTerm": { "type": "boolean" }, "documentsProvider": { "type": "boolean" }, "entityName": { "type": "boolean" }, "estimatedMultiple": { "type": "boolean" }, "estimatedAssetCount": { "type": "boolean" }, "internationalInvestors": { "type": "boolean" }, "hasAccreditedInvestors": { "type": "boolean" }, "hasQualifiedPurchasers": { "type": "boolean" }, "hasInstitutionalInvestors": { "type": "boolean" }, "internationalTransactionsExpected": { "type": "boolean" }, "nonUsFinancialInstitutions": { "type": "boolean" }, "legacyCompanyName": { "type": "boolean" }, "legalTemplateOption": { "type": "boolean" }, "masterSeries": { "type": "boolean" }, "onboardingLink": { "type": "boolean" }, "seriesName": { "type": "boolean" }, "subType": { "type": "boolean" }, "agreeMsa": { "type": "boolean" }, "agreeCosts": { "type": "boolean" }, "agreeSetup": { "type": "boolean" }, "masterSeriesId": { "type": "boolean" }, "investorType": { "type": "boolean" }, "advisorTypeNote": { "type": "boolean" }, "bankingProviderNote": { "type": "boolean" }, "fundManagerEmail": { "type": "boolean" }, "financialStatementFrequency": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "dealId", "acceptCrypto", "advisorType", "assetId", "bankAccountId", "bankingProvider", "dealTerm", "documentsProvider", "entityName", "estimatedMultiple", "estimatedAssetCount", "internationalInvestors", "hasAccreditedInvestors", "hasQualifiedPurchasers", "hasInstitutionalInvestors", "internationalTransactionsExpected", "nonUsFinancialInstitutions", "legacyCompanyName", "legalTemplateOption", "masterSeries", "onboardingLink", "seriesName", "subType", "agreeMsa", "agreeCosts", "agreeSetup", "masterSeriesId", "investorType", "advisorTypeNote", "bankingProviderNote", "fundManagerEmail", "financialStatementFrequency" ], "example": "id" }, "uniqueItems": true } ], "title": "DealDetails.Fields" }, "include": { "title": "DealDetails.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/DealDetails.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Files.Filter": { "type": "object", "title": "Files.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Files.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "key": { "type": "boolean" }, "type": { "type": "boolean" }, "mongoOwnerId": { "type": "boolean" }, "legacyBucket": { "type": "boolean" }, "legacyKey": { "type": "boolean" }, "fileName": { "type": "boolean" }, "mongoDocumentsId": { "type": "boolean" }, "contentType": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "bucket": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "key", "type", "mongoOwnerId", "legacyBucket", "legacyKey", "fileName", "mongoDocumentsId", "contentType", "userEmail", "userId", "bucket" ], "example": "id" }, "uniqueItems": true } ], "title": "Files.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Investments.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Investments.ScopeFilter" }, "Investments.IncludeFilter.Items": { "title": "Investments.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "distributionTransferInformation", "identity", "deal", "investmentsTaxes", "files", "transferInformation" ] }, "scope": { "$ref": "#/components/schemas/Investments.ScopeFilter" } } }, "Investments.Filter": { "type": "object", "title": "Investments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Investments.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "blueskyFees": { "type": "boolean" }, "capitalWiredAmount": { "type": "boolean" }, "carry": { "type": "boolean" }, "managementFeePercent": { "type": "boolean" }, "managementFeesDollars": { "type": "boolean" }, "netInvestment": { "type": "boolean" }, "otherExpenses": { "type": "boolean" }, "privateFundExpenses": { "type": "boolean" }, "spvFees": { "type": "boolean" }, "subscriptionAmount": { "type": "boolean" }, "completeAt": { "type": "boolean" }, "ledgerMatched": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "mongoInvestmentId": { "type": "boolean" }, "mongoUserId": { "type": "boolean" }, "invitedAtLegacy": { "type": "boolean" }, "status": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "manualEntryWireDate": { "type": "boolean" }, "source": { "type": "boolean" }, "invitedAt": { "type": "boolean" }, "wiredDate": { "type": "boolean" }, "distributionAssetType": { "type": "boolean" }, "distributionTransferInfoId": { "type": "boolean" }, "identitiesId": { "type": "boolean" }, "dealId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "blueskyFees", "capitalWiredAmount", "carry", "managementFeePercent", "managementFeesDollars", "netInvestment", "otherExpenses", "privateFundExpenses", "spvFees", "subscriptionAmount", "completeAt", "ledgerMatched", "mongoDealId", "mongoInvestmentId", "mongoUserId", "invitedAtLegacy", "status", "userEmail", "isMigration", "manualEntryWireDate", "source", "invitedAt", "wiredDate", "distributionAssetType", "distributionTransferInfoId", "identitiesId", "dealId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "Investments.Fields" }, "include": { "title": "Investments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Investments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Invitations.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Invitations.ScopeFilter" }, "Invitations.IncludeFilter.Items": { "title": "Invitations.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal" ] }, "scope": { "$ref": "#/components/schemas/Invitations.ScopeFilter" } } }, "Invitations.Filter": { "type": "object", "title": "Invitations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Invitations.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "recipientEmail": { "type": "boolean" }, "dealId": { "type": "boolean" }, "amount": { "type": "boolean" }, "type": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userEmail", "userId", "recipientEmail", "dealId", "amount", "type" ], "example": "id" }, "uniqueItems": true } ], "title": "Invitations.Fields" }, "include": { "title": "Invitations.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Invitations.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "GenericError": { "type": "object", "title": "GenericError", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "DealsViews.Filter": { "type": "object", "title": "DealsViews.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DealsViews.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "dealId": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "dealId", "userEmail", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "DealsViews.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Deals.Filter1": { "type": "object", "title": "Deals.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "name": { "type": "boolean" }, "type": { "type": "boolean" }, "status": { "type": "boolean" }, "minimumInvestment": { "type": "boolean" }, "closingDate": { "type": "boolean" }, "offeringType": { "type": "boolean" }, "managementFeeFrequency": { "type": "boolean" }, "managementFeePercent": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "mongoOrganizationId": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "targetRaiseGoal": { "type": "boolean" }, "totalCarry": { "type": "boolean" }, "slug": { "type": "boolean" }, "memo": { "type": "boolean" }, "documentsTemplateId": { "type": "boolean" }, "documentsProvider": { "type": "boolean" }, "shortcodeId": { "type": "boolean" }, "totalCarryNotes": { "type": "boolean" }, "managementFeeNotes": { "type": "boolean" }, "closedDate": { "type": "boolean" }, "tags": { "type": "boolean" }, "migrationApproval": { "type": "boolean" }, "migrationApprovalDate": { "type": "boolean" }, "migrationApprovalEmail": { "type": "boolean" }, "migrationFmSent": { "type": "boolean" }, "invoiceAmount": { "type": "boolean" }, "invoiceNumber": { "type": "boolean" }, "invoiceStatus": { "type": "boolean" }, "capitalAccountStatementURI": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "advisorStatus": { "type": "boolean" }, "entityId": { "type": "boolean" }, "fmIdentityId": { "type": "boolean" }, "advisorId": { "type": "boolean" }, "organizationId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "name", "type", "status", "minimumInvestment", "closingDate", "offeringType", "managementFeeFrequency", "managementFeePercent", "userEmail", "userId", "mongoDealId", "mongoOrganizationId", "isMigration", "targetRaiseGoal", "totalCarry", "slug", "memo", "documentsTemplateId", "documentsProvider", "shortcodeId", "totalCarryNotes", "managementFeeNotes", "closedDate", "tags", "migrationApproval", "migrationApprovalDate", "migrationApprovalEmail", "migrationFmSent", "invoiceAmount", "invoiceNumber", "invoiceStatus", "capitalAccountStatementURI", "phoneNumber", "invoiceDate", "advisorStatus", "entityId", "fmIdentityId", "advisorId", "organizationId" ], "example": "id" }, "uniqueItems": true } ], "title": "Deals.Fields" }, "include": { "title": "Deals.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Deals.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "SellOrderRequests.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "SellOrderRequests.ScopeFilter" }, "SellOrderRequests.IncludeFilter.Items": { "title": "SellOrderRequests.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal", "investment", "user" ] }, "scope": { "$ref": "#/components/schemas/SellOrderRequests.ScopeFilter" } } }, "SellOrderRequests.Filter": { "type": "object", "title": "SellOrderRequests.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "SellOrderRequests.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "dealId": { "type": "boolean" }, "investmentId": { "type": "boolean" }, "userId": { "type": "boolean" }, "amount": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "dealId", "investmentId", "userId", "amount", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "SellOrderRequests.Fields" }, "include": { "title": "SellOrderRequests.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SellOrderRequests.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Investments.Filter1": { "type": "object", "title": "Investments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "blueskyFees": { "type": "boolean" }, "capitalWiredAmount": { "type": "boolean" }, "carry": { "type": "boolean" }, "managementFeePercent": { "type": "boolean" }, "managementFeesDollars": { "type": "boolean" }, "netInvestment": { "type": "boolean" }, "otherExpenses": { "type": "boolean" }, "privateFundExpenses": { "type": "boolean" }, "spvFees": { "type": "boolean" }, "subscriptionAmount": { "type": "boolean" }, "completeAt": { "type": "boolean" }, "ledgerMatched": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "mongoInvestmentId": { "type": "boolean" }, "mongoUserId": { "type": "boolean" }, "invitedAtLegacy": { "type": "boolean" }, "status": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "manualEntryWireDate": { "type": "boolean" }, "source": { "type": "boolean" }, "invitedAt": { "type": "boolean" }, "wiredDate": { "type": "boolean" }, "distributionAssetType": { "type": "boolean" }, "distributionTransferInfoId": { "type": "boolean" }, "identitiesId": { "type": "boolean" }, "dealId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "blueskyFees", "capitalWiredAmount", "carry", "managementFeePercent", "managementFeesDollars", "netInvestment", "otherExpenses", "privateFundExpenses", "spvFees", "subscriptionAmount", "completeAt", "ledgerMatched", "mongoDealId", "mongoInvestmentId", "mongoUserId", "invitedAtLegacy", "status", "userEmail", "isMigration", "manualEntryWireDate", "source", "invitedAt", "wiredDate", "distributionAssetType", "distributionTransferInfoId", "identitiesId", "dealId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "Investments.Fields" }, "include": { "title": "Investments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Investments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Ledgers.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Ledgers.ScopeFilter" }, "Ledgers.IncludeFilter.Items": { "title": "Ledgers.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "user", "organization", "entity", "accounts" ] }, "scope": { "$ref": "#/components/schemas/Ledgers.ScopeFilter" } } }, "Ledgers.Filter": { "type": "object", "title": "Ledgers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Ledgers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userId": { "type": "boolean" }, "organizationId": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userId", "organizationId", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "Ledgers.Fields" }, "include": { "title": "Ledgers.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Ledgers.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "LedgerEntries.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "LedgerEntries.ScopeFilter" }, "LedgerEntries.IncludeFilter.Items": { "title": "LedgerEntries.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "user", "transaction", "account", "counterAccount", "ledger", "ledgerEntryRelationships" ] }, "scope": { "$ref": "#/components/schemas/LedgerEntries.ScopeFilter" } } }, "LedgerEntries.Filter": { "type": "object", "title": "LedgerEntries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "LedgerEntries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userId": { "type": "boolean" }, "transactionId": { "type": "boolean" }, "accountId": { "type": "boolean" }, "counterAccountId": { "type": "boolean" }, "ledgerId": { "type": "boolean" }, "amount": { "type": "boolean" }, "description": { "type": "boolean" }, "date": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userId", "transactionId", "accountId", "counterAccountId", "ledgerId", "amount", "description", "date" ], "example": "id" }, "uniqueItems": true } ], "title": "LedgerEntries.Fields" }, "include": { "title": "LedgerEntries.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/LedgerEntries.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "loopback.Count": { "type": "object", "title": "loopback.Count", "x-typescript-type": "@loopback/repository#Count", "properties": { "count": { "type": "number" } } }, "TransferRequest.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "TransferRequest.ScopeFilter" }, "TransferRequest.IncludeFilter.Items": { "title": "TransferRequest.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "recipient", "requestedBy", "deal", "entity" ] }, "scope": { "$ref": "#/components/schemas/TransferRequest.ScopeFilter" } } }, "TransferRequest.Filter": { "type": "object", "title": "TransferRequest.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "recipientId": { "type": "boolean" }, "status": { "type": "boolean" }, "requestedAmount": { "type": "boolean" }, "sentAmount": { "type": "boolean" }, "declaredPurpose": { "type": "boolean" }, "recipientData": { "type": "boolean" }, "userId": { "type": "boolean" }, "dealId": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "recipientId", "status", "requestedAmount", "sentAmount", "declaredPurpose", "recipientData", "userId", "dealId", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "TransferRequest.Fields" }, "include": { "title": "TransferRequest.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TransferRequest.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransferRequest.Filter1": { "type": "object", "title": "TransferRequest.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TransferRequest.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "recipientId": { "type": "boolean" }, "status": { "type": "boolean" }, "requestedAmount": { "type": "boolean" }, "sentAmount": { "type": "boolean" }, "declaredPurpose": { "type": "boolean" }, "recipientData": { "type": "boolean" }, "userId": { "type": "boolean" }, "dealId": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "recipientId", "status", "requestedAmount", "sentAmount", "declaredPurpose", "recipientData", "userId", "dealId", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "TransferRequest.Fields" }, "include": { "title": "TransferRequest.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TransferRequest.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Announcements.Filter": { "type": "object", "title": "Announcements.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "slug": { "type": "boolean" }, "message": { "type": "boolean" }, "enabled": { "type": "boolean" }, "title": { "type": "boolean" }, "classes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "slug", "message", "enabled", "title", "classes" ], "example": "id" }, "uniqueItems": true } ], "title": "Announcements.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Announcements.Filter1": { "type": "object", "title": "Announcements.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Announcements.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "slug": { "type": "boolean" }, "message": { "type": "boolean" }, "enabled": { "type": "boolean" }, "title": { "type": "boolean" }, "classes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "slug", "message", "enabled", "title", "classes" ], "example": "id" }, "uniqueItems": true } ], "title": "Announcements.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Distributions.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Distributions.ScopeFilter" }, "Distributions.IncludeFilter.Items": { "title": "Distributions.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal", "distributionsInvestments", "distributionEvents" ] }, "scope": { "$ref": "#/components/schemas/Distributions.ScopeFilter" } } }, "Distributions.Filter": { "type": "object", "title": "Distributions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "userId": { "type": "boolean" }, "requestedReceivingDate": { "type": "boolean" }, "note": { "type": "boolean" }, "sheetUri": { "type": "boolean" }, "dealId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "status", "userId", "requestedReceivingDate", "note", "sheetUri", "dealId" ], "example": "id" }, "uniqueItems": true } ], "title": "Distributions.Fields" }, "include": { "title": "Distributions.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Distributions.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Distributions.Filter1": { "type": "object", "title": "Distributions.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Distributions.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "userId": { "type": "boolean" }, "requestedReceivingDate": { "type": "boolean" }, "note": { "type": "boolean" }, "sheetUri": { "type": "boolean" }, "dealId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "status", "userId", "requestedReceivingDate", "note", "sheetUri", "dealId" ], "example": "id" }, "uniqueItems": true } ], "title": "Distributions.Fields" }, "include": { "title": "Distributions.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Distributions.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DistributionsInvestments.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "DistributionsInvestments.ScopeFilter" }, "DistributionsInvestments.IncludeFilter.Items": { "title": "DistributionsInvestments.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "distribution", "investment" ] }, "scope": { "$ref": "#/components/schemas/DistributionsInvestments.ScopeFilter" } } }, "DistributionsInvestments.Filter": { "type": "object", "title": "DistributionsInvestments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "amount": { "type": "boolean" }, "transferInformation": { "type": "boolean" }, "method": { "type": "boolean" }, "distributionDate": { "type": "boolean" }, "status": { "type": "boolean" }, "transactionHash": { "type": "boolean" }, "notes": { "type": "boolean" }, "distributionId": { "type": "boolean" }, "investmentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "amount", "transferInformation", "method", "distributionDate", "status", "transactionHash", "notes", "distributionId", "investmentId" ], "example": "id" }, "uniqueItems": true } ], "title": "DistributionsInvestments.Fields" }, "include": { "title": "DistributionsInvestments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/DistributionsInvestments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DistributionsInvestments.Filter1": { "type": "object", "title": "DistributionsInvestments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DistributionsInvestments.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "amount": { "type": "boolean" }, "transferInformation": { "type": "boolean" }, "method": { "type": "boolean" }, "distributionDate": { "type": "boolean" }, "status": { "type": "boolean" }, "transactionHash": { "type": "boolean" }, "notes": { "type": "boolean" }, "distributionId": { "type": "boolean" }, "investmentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "amount", "transferInformation", "method", "distributionDate", "status", "transactionHash", "notes", "distributionId", "investmentId" ], "example": "id" }, "uniqueItems": true } ], "title": "DistributionsInvestments.Fields" }, "include": { "title": "DistributionsInvestments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/DistributionsInvestments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransferInformation.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "TransferInformation.ScopeFilter" }, "TransferInformation.IncludeFilter.Items": { "title": "TransferInformation.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "identity" ] }, "scope": { "$ref": "#/components/schemas/TransferInformation.ScopeFilter" } } }, "TransferInformation.Filter": { "type": "object", "title": "TransferInformation.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TransferInformation.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "accountId": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "assetType": { "type": "boolean" }, "method": { "type": "boolean" }, "bankName": { "type": "boolean" }, "bankAddress": { "type": "boolean" }, "bankAccountType": { "type": "boolean" }, "beneficiaryName": { "type": "boolean" }, "beneficiaryAddress": { "type": "boolean" }, "beneficiaryPhoneNumber": { "type": "boolean" }, "memo": { "type": "boolean" }, "brokerageFirmName": { "type": "boolean" }, "accountType": { "type": "boolean" }, "dtcParticipantNumber": { "type": "boolean" }, "additionalAccountInformation": { "type": "boolean" }, "identityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "accountId", "routingNumber", "assetType", "method", "bankName", "bankAddress", "bankAccountType", "beneficiaryName", "beneficiaryAddress", "beneficiaryPhoneNumber", "memo", "brokerageFirmName", "accountType", "dtcParticipantNumber", "additionalAccountInformation", "identityId" ], "example": "id" }, "uniqueItems": true } ], "title": "TransferInformation.Fields" }, "include": { "title": "TransferInformation.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TransferInformation.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TransferInformation.Filter1": { "type": "object", "title": "TransferInformation.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "accountId": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "assetType": { "type": "boolean" }, "method": { "type": "boolean" }, "bankName": { "type": "boolean" }, "bankAddress": { "type": "boolean" }, "bankAccountType": { "type": "boolean" }, "beneficiaryName": { "type": "boolean" }, "beneficiaryAddress": { "type": "boolean" }, "beneficiaryPhoneNumber": { "type": "boolean" }, "memo": { "type": "boolean" }, "brokerageFirmName": { "type": "boolean" }, "accountType": { "type": "boolean" }, "dtcParticipantNumber": { "type": "boolean" }, "additionalAccountInformation": { "type": "boolean" }, "identityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "accountId", "routingNumber", "assetType", "method", "bankName", "bankAddress", "bankAccountType", "beneficiaryName", "beneficiaryAddress", "beneficiaryPhoneNumber", "memo", "brokerageFirmName", "accountType", "dtcParticipantNumber", "additionalAccountInformation", "identityId" ], "example": "id" }, "uniqueItems": true } ], "title": "TransferInformation.Fields" }, "include": { "title": "TransferInformation.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/TransferInformation.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Accreditations.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Accreditations.ScopeFilter" }, "Accreditations.IncludeFilter.Items": { "title": "Accreditations.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "identity", "user" ] }, "scope": { "$ref": "#/components/schemas/Accreditations.ScopeFilter" } } }, "Accreditations.Filter": { "type": "object", "title": "Accreditations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "type": { "type": "boolean" }, "user_investment_entity_id": { "type": "boolean" }, "description": { "type": "boolean" }, "value": { "type": "boolean" }, "identitiesId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userEmail", "type", "user_investment_entity_id", "description", "value", "identitiesId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "Accreditations.Fields" }, "include": { "title": "Accreditations.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Accreditations.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Accreditations.Filter1": { "type": "object", "title": "Accreditations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Accreditations.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "type": { "type": "boolean" }, "user_investment_entity_id": { "type": "boolean" }, "description": { "type": "boolean" }, "value": { "type": "boolean" }, "identitiesId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userEmail", "type", "user_investment_entity_id", "description", "value", "identitiesId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "Accreditations.Fields" }, "include": { "title": "Accreditations.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Accreditations.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BankAccounts.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "BankAccounts.ScopeFilter" }, "BankAccounts.IncludeFilter.Items": { "title": "BankAccounts.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal", "entity", "transactions" ] }, "scope": { "$ref": "#/components/schemas/BankAccounts.ScopeFilter" } } }, "BankAccounts.Filter": { "type": "object", "title": "BankAccounts.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "dealId": { "type": "boolean" }, "accountNumber": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "accountName": { "type": "boolean" }, "bankName": { "type": "boolean" }, "lastSuccessfulSync": { "type": "boolean" }, "syncStatus": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "providerApplicationId": { "type": "boolean" }, "applicationStatus": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "status": { "type": "boolean" }, "providerData": { "type": "boolean" }, "currentBalance": { "type": "boolean" }, "availableBalance": { "type": "boolean" }, "notes": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "dealId", "accountNumber", "routingNumber", "accountName", "bankName", "lastSuccessfulSync", "syncStatus", "provider", "providerId", "providerApplicationId", "applicationStatus", "userEmail", "status", "providerData", "currentBalance", "availableBalance", "notes", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "BankAccounts.Fields" }, "include": { "title": "BankAccounts.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BankAccounts.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BankAccounts.Filter1": { "type": "object", "title": "BankAccounts.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BankAccounts.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "dealId": { "type": "boolean" }, "accountNumber": { "type": "boolean" }, "routingNumber": { "type": "boolean" }, "accountName": { "type": "boolean" }, "bankName": { "type": "boolean" }, "lastSuccessfulSync": { "type": "boolean" }, "syncStatus": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "providerApplicationId": { "type": "boolean" }, "applicationStatus": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "status": { "type": "boolean" }, "providerData": { "type": "boolean" }, "currentBalance": { "type": "boolean" }, "availableBalance": { "type": "boolean" }, "notes": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "dealId", "accountNumber", "routingNumber", "accountName", "bankName", "lastSuccessfulSync", "syncStatus", "provider", "providerId", "providerApplicationId", "applicationStatus", "userEmail", "status", "providerData", "currentBalance", "availableBalance", "notes", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "BankAccounts.Fields" }, "include": { "title": "BankAccounts.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/BankAccounts.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "EntitiesTaxes.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "EntitiesTaxes.ScopeFilter" }, "EntitiesTaxes.IncludeFilter.Items": { "title": "EntitiesTaxes.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "entities" ] }, "scope": { "$ref": "#/components/schemas/EntitiesTaxes.ScopeFilter" } } }, "EntitiesTaxes.Filter": { "type": "object", "title": "EntitiesTaxes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "irsAcceptedDate": { "type": "boolean" }, "importRequested": { "type": "boolean" }, "lastImportedAt": { "type": "boolean" }, "printRequested": { "type": "boolean" }, "lastPrintedAt": { "type": "boolean" }, "importState": { "type": "boolean" }, "filingStatus": { "type": "boolean" }, "entityName": { "type": "boolean" }, "entityEin": { "type": "boolean" }, "entityFormationDate": { "type": "boolean" }, "entityStreetAddress": { "type": "boolean" }, "entityCity": { "type": "boolean" }, "entityState": { "type": "boolean" }, "entityPostalCode": { "type": "boolean" }, "entityPhoneNumber": { "type": "boolean" }, "signerFirstName": { "type": "boolean" }, "signerLastName": { "type": "boolean" }, "signerTitle": { "type": "boolean" }, "signerSignatureDate": { "type": "boolean" }, "signerSignature": { "type": "boolean" }, "isInitialReturn": { "type": "boolean" }, "isAmendmentReturn": { "type": "boolean" }, "isFinalReturn": { "type": "boolean" }, "entityType": { "type": "boolean" }, "entitySatisfiesReceiptsAndAssets": { "type": "boolean" }, "partnershipRepresentativeName": { "type": "boolean" }, "partnershipRepresentativeStreetAddress": { "type": "boolean" }, "partnershipRepresentativeCity": { "type": "boolean" }, "partnershipRepresentativeZip": { "type": "boolean" }, "partnershipRepresentativePhone": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualFirstName": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualLastName": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualStreetAddress": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualCity": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualState": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualZip": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualPhone": { "type": "boolean" }, "entityBeginningCash": { "type": "boolean" }, "entityEndingCash": { "type": "boolean" }, "entityBeginningLongTermAssets": { "type": "boolean" }, "entityEndingLongTermAssets": { "type": "boolean" }, "entityBeginningCurrentLiabilities": { "type": "boolean" }, "entityEndingCurrentLiabilities": { "type": "boolean" }, "entityBeginningCapital": { "type": "boolean" }, "entityCapitalContributions": { "type": "boolean" }, "entityCashDistributions": { "type": "boolean" }, "entityPortfolioExpense": { "type": "boolean" }, "entityHasForeignInvestors": { "type": "boolean" }, "hasNotifiedLps": { "type": "boolean" }, "taxYear": { "type": "boolean" }, "provider": { "type": "boolean" }, "taxType": { "type": "boolean" }, "portfolioExpenseDescription": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualEmail": { "type": "boolean" }, "providerId": { "type": "boolean" }, "extensionFiled": { "type": "boolean" }, "partnershipRepresentativeState": { "type": "boolean" }, "organizationId": { "type": "boolean" }, "batch": { "type": "boolean" }, "allocationsApproval": { "type": "boolean" }, "fundManagerApprovalDate": { "type": "boolean" }, "1065FilesId": { "type": "boolean" }, "fundManagerApprovalEmail": { "type": "boolean" }, "fundManagerInvited": { "type": "boolean" }, "fundManagerApproval": { "type": "boolean" }, "calculatorVersion": { "type": "boolean" }, "irsSubmissionId": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "irsAcceptedDate", "importRequested", "lastImportedAt", "printRequested", "lastPrintedAt", "importState", "filingStatus", "entityName", "entityEin", "entityFormationDate", "entityStreetAddress", "entityCity", "entityState", "entityPostalCode", "entityPhoneNumber", "signerFirstName", "signerLastName", "signerTitle", "signerSignatureDate", "signerSignature", "isInitialReturn", "isAmendmentReturn", "isFinalReturn", "entityType", "entitySatisfiesReceiptsAndAssets", "partnershipRepresentativeName", "partnershipRepresentativeStreetAddress", "partnershipRepresentativeCity", "partnershipRepresentativeZip", "partnershipRepresentativePhone", "partnershipRepresentativeDesignatedIndividualFirstName", "partnershipRepresentativeDesignatedIndividualLastName", "partnershipRepresentativeDesignatedIndividualStreetAddress", "partnershipRepresentativeDesignatedIndividualCity", "partnershipRepresentativeDesignatedIndividualState", "partnershipRepresentativeDesignatedIndividualZip", "partnershipRepresentativeDesignatedIndividualPhone", "entityBeginningCash", "entityEndingCash", "entityBeginningLongTermAssets", "entityEndingLongTermAssets", "entityBeginningCurrentLiabilities", "entityEndingCurrentLiabilities", "entityBeginningCapital", "entityCapitalContributions", "entityCashDistributions", "entityPortfolioExpense", "entityHasForeignInvestors", "hasNotifiedLps", "taxYear", "provider", "taxType", "portfolioExpenseDescription", "partnershipRepresentativeDesignatedIndividualEmail", "providerId", "extensionFiled", "partnershipRepresentativeState", "organizationId", "batch", "allocationsApproval", "fundManagerApprovalDate", "1065FilesId", "fundManagerApprovalEmail", "fundManagerInvited", "fundManagerApproval", "calculatorVersion", "irsSubmissionId", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "EntitiesTaxes.Fields" }, "include": { "title": "EntitiesTaxes.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/EntitiesTaxes.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Entities.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Entities.ScopeFilter" }, "Entities.IncludeFilter.Items": { "title": "Entities.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deals", "entitiesTaxes", "investmentsTaxes", "legacyLedgers", "ledger", "partnershipRepresentative", "partnershipRepresentativeDesignatedIndividual", "parentEntity", "organization", "entitiesTaxesMetadata" ] }, "scope": { "$ref": "#/components/schemas/Entities.ScopeFilter" } } }, "Entities.Filter": { "type": "object", "title": "Entities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "formationDate": { "type": "boolean" }, "streetAddress": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "name": { "type": "boolean" }, "entityType": { "type": "boolean" }, "organizationName": { "type": "boolean" }, "mongoOrganizationId": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "ein": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "fundManager": { "type": "boolean" }, "taxStatus": { "type": "boolean" }, "status": { "type": "boolean" }, "returnId": { "type": "boolean" }, "taxesProvider": { "type": "boolean" }, "taxesProviderId": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "partnershipRepresentativeId": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualId": { "type": "boolean" }, "parentEntityId": { "type": "boolean" }, "organizationId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "formationDate", "streetAddress", "city", "state", "postalCode", "phoneNumber", "name", "entityType", "organizationName", "mongoOrganizationId", "mongoDealId", "ein", "userEmail", "fundManager", "taxStatus", "status", "returnId", "taxesProvider", "taxesProviderId", "isMigration", "partnershipRepresentativeId", "partnershipRepresentativeDesignatedIndividualId", "parentEntityId", "organizationId" ], "example": "id" }, "uniqueItems": true } ], "title": "Entities.Fields" }, "include": { "title": "Entities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Entities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Entities.Filter1": { "type": "object", "title": "Entities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Entities.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "formationDate": { "type": "boolean" }, "streetAddress": { "type": "boolean" }, "city": { "type": "boolean" }, "state": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "phoneNumber": { "type": "boolean" }, "name": { "type": "boolean" }, "entityType": { "type": "boolean" }, "organizationName": { "type": "boolean" }, "mongoOrganizationId": { "type": "boolean" }, "mongoDealId": { "type": "boolean" }, "ein": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "fundManager": { "type": "boolean" }, "taxStatus": { "type": "boolean" }, "status": { "type": "boolean" }, "returnId": { "type": "boolean" }, "taxesProvider": { "type": "boolean" }, "taxesProviderId": { "type": "boolean" }, "isMigration": { "type": "boolean" }, "partnershipRepresentativeId": { "type": "boolean" }, "partnershipRepresentativeDesignatedIndividualId": { "type": "boolean" }, "parentEntityId": { "type": "boolean" }, "organizationId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "formationDate", "streetAddress", "city", "state", "postalCode", "phoneNumber", "name", "entityType", "organizationName", "mongoOrganizationId", "mongoDealId", "ein", "userEmail", "fundManager", "taxStatus", "status", "returnId", "taxesProvider", "taxesProviderId", "isMigration", "partnershipRepresentativeId", "partnershipRepresentativeDesignatedIndividualId", "parentEntityId", "organizationId" ], "example": "id" }, "uniqueItems": true } ], "title": "Entities.Fields" }, "include": { "title": "Entities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Entities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "IdentityFiles.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "IdentityFiles.ScopeFilter" }, "IdentityFiles.IncludeFilter.Items": { "title": "IdentityFiles.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "identity" ] }, "scope": { "$ref": "#/components/schemas/IdentityFiles.ScopeFilter" } } }, "IdentityFiles.Filter": { "type": "object", "title": "IdentityFiles.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "path": { "type": "boolean" }, "mimeType": { "type": "boolean" }, "fileType": { "type": "boolean" }, "side": { "type": "boolean" }, "validationResult": { "type": "boolean" }, "validationRawResult": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "identityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "path", "mimeType", "fileType", "side", "validationResult", "validationRawResult", "provider", "providerId", "identityId" ], "example": "id" }, "uniqueItems": true } ], "title": "IdentityFiles.Fields" }, "include": { "title": "IdentityFiles.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/IdentityFiles.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Identities.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Identities.ScopeFilter" }, "Identities.IncludeFilter.Items": { "title": "Identities.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "investments", "kycChecks", "identityFiles", "relations", "accreditations", "transferInformation" ] }, "scope": { "$ref": "#/components/schemas/Identities.ScopeFilter" } } }, "Identities.Filter": { "type": "object", "title": "Identities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "type": { "type": "boolean" }, "entityType": { "type": "boolean" }, "taxId": { "type": "boolean" }, "taxIdType": { "type": "boolean" }, "addressLine_1": { "type": "boolean" }, "addressLine_2": { "type": "boolean" }, "city": { "type": "boolean" }, "region": { "type": "boolean" }, "country": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "usDomestic": { "type": "boolean" }, "entityIsDisregarded": { "type": "boolean" }, "ownershipPercent": { "type": "boolean" }, "phone": { "type": "boolean" }, "parentIdentityId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "dateOfEntityFormation": { "type": "boolean" }, "legalName": { "type": "boolean" }, "title": { "type": "boolean" }, "archived": { "type": "boolean" }, "countryOfCitizenship": { "type": "boolean" }, "status": { "type": "boolean" }, "isMigration": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userEmail", "userId", "type", "entityType", "taxId", "taxIdType", "addressLine_1", "addressLine_2", "city", "region", "country", "postalCode", "usDomestic", "entityIsDisregarded", "ownershipPercent", "phone", "parentIdentityId", "provider", "providerId", "dateOfEntityFormation", "legalName", "title", "archived", "countryOfCitizenship", "status", "isMigration" ], "example": "id" }, "uniqueItems": true } ], "title": "Identities.Fields" }, "include": { "title": "Identities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Identities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Identities.Filter1": { "type": "object", "title": "Identities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Identities.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "userId": { "type": "boolean" }, "type": { "type": "boolean" }, "entityType": { "type": "boolean" }, "taxId": { "type": "boolean" }, "taxIdType": { "type": "boolean" }, "addressLine_1": { "type": "boolean" }, "addressLine_2": { "type": "boolean" }, "city": { "type": "boolean" }, "region": { "type": "boolean" }, "country": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "usDomestic": { "type": "boolean" }, "entityIsDisregarded": { "type": "boolean" }, "ownershipPercent": { "type": "boolean" }, "phone": { "type": "boolean" }, "parentIdentityId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "dateOfEntityFormation": { "type": "boolean" }, "legalName": { "type": "boolean" }, "title": { "type": "boolean" }, "archived": { "type": "boolean" }, "countryOfCitizenship": { "type": "boolean" }, "status": { "type": "boolean" }, "isMigration": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "userEmail", "userId", "type", "entityType", "taxId", "taxIdType", "addressLine_1", "addressLine_2", "city", "region", "country", "postalCode", "usDomestic", "entityIsDisregarded", "ownershipPercent", "phone", "parentIdentityId", "provider", "providerId", "dateOfEntityFormation", "legalName", "title", "archived", "countryOfCitizenship", "status", "isMigration" ], "example": "id" }, "uniqueItems": true } ], "title": "Identities.Fields" }, "include": { "title": "Identities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Identities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Notifications": { "title": "Notifications", "type": "object", "properties": { "id": { "type": "string", "nullable": false }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "string", "format": "date-time", "nullable": true }, "deletedBy": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "subject": { "type": "string", "nullable": true }, "body": { "type": "string" }, "options": { "type": "object" }, "isCritical": { "type": "boolean" }, "senderUserId": { "type": "string" } }, "required": [ "body" ], "additionalProperties": false, "description": "Notification details" }, "Notification": { "title": "Notification", "type": "object", "description": "Notification Details", "properties": { "id": { "type": "string", "nullable": false }, "createdAt": { "type": "string", "format": "date-time", "nullable": false }, "updatedAt": { "type": "string", "format": "date-time", "nullable": false }, "subject": { "type": "string", "nullable": true }, "body": { "type": "string" }, "isCritical": { "type": "boolean" } }, "required": [ "body" ], "additionalProperties": false }, "ListingNotification": { "title": "ListingNotification", "type": "object", "description": "Listing notifications for the current user", "properties": { "id": { "type": "string", "nullable": false }, "notificationId": { "type": "string" }, "isRead": { "type": "boolean" }, "types": { "type": "array", "items": { "type": "string" } }, "sentDate": { "type": "string", "format": "date-time" }, "actionMeta": { "type": "object", "description": "Action Data for Notification, typically url and title" }, "userId": { "type": "string" }, "notification": { "$ref": "#/components/schemas/Notification" } }, "additionalProperties": false }, "NotificationUsers.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "NotificationUsers.ScopeFilter" }, "NotificationUsers.IncludeFilter.Items": { "title": "NotificationUsers.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "notification", "user" ] }, "scope": { "$ref": "#/components/schemas/NotificationUsers.ScopeFilter" } } }, "NotificationUsers.Filter": { "type": "object", "title": "NotificationUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "NotificationUsers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "notificationId": { "type": "boolean" }, "isRead": { "type": "boolean" }, "types": { "type": "boolean" }, "sentDate": { "type": "boolean" }, "actionMeta": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "notificationId", "isRead", "types", "sentDate", "actionMeta", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "NotificationUsers.Fields" }, "include": { "title": "NotificationUsers.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/NotificationUsers.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Organizations.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Organizations.ScopeFilter" }, "Organizations.IncludeFilter.Items": { "title": "Organizations.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deals", "entities", "roles", "representativeIdentity", "representativeIndividualIdentity" ] }, "scope": { "$ref": "#/components/schemas/Organizations.ScopeFilter" } } }, "Organizations.Filter": { "type": "object", "title": "Organizations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "mongoId": { "type": "boolean" }, "name": { "type": "boolean" }, "slug": { "type": "boolean" }, "approved": { "type": "boolean" }, "highVolumePartner": { "type": "boolean" }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "boolean" }, "mouSigned": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "phase": { "type": "boolean" }, "addressLine1": { "type": "boolean" }, "addressLine2": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "region": { "type": "boolean" }, "country": { "type": "boolean" }, "city": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "tags": { "type": "boolean" }, "representativeIdentityId": { "type": "boolean" }, "representativeIndividualIdentityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "status", "mongoId", "name", "slug", "approved", "highVolumePartner", "accessDisabled", "legalName", "mouSigned", "userEmail", "phase", "addressLine1", "addressLine2", "postalCode", "region", "country", "city", "isArchived", "tags", "representativeIdentityId", "representativeIndividualIdentityId" ], "example": "id" }, "uniqueItems": true } ], "title": "Organizations.Fields" }, "include": { "title": "Organizations.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Organizations.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Organizations.Filter1": { "type": "object", "title": "Organizations.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Organizations.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "status": { "type": "boolean" }, "mongoId": { "type": "boolean" }, "name": { "type": "boolean" }, "slug": { "type": "boolean" }, "approved": { "type": "boolean" }, "highVolumePartner": { "type": "boolean" }, "accessDisabled": { "type": "boolean" }, "legalName": { "type": "boolean" }, "mouSigned": { "type": "boolean" }, "userEmail": { "type": "boolean" }, "phase": { "type": "boolean" }, "addressLine1": { "type": "boolean" }, "addressLine2": { "type": "boolean" }, "postalCode": { "type": "boolean" }, "region": { "type": "boolean" }, "country": { "type": "boolean" }, "city": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "tags": { "type": "boolean" }, "representativeIdentityId": { "type": "boolean" }, "representativeIndividualIdentityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "status", "mongoId", "name", "slug", "approved", "highVolumePartner", "accessDisabled", "legalName", "mouSigned", "userEmail", "phase", "addressLine1", "addressLine2", "postalCode", "region", "country", "city", "isArchived", "tags", "representativeIdentityId", "representativeIndividualIdentityId" ], "example": "id" }, "uniqueItems": true } ], "title": "Organizations.Fields" }, "include": { "title": "Organizations.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Organizations.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "InvestmentsTaxes.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "InvestmentsTaxes.ScopeFilter" }, "InvestmentsTaxes.IncludeFilter.Items": { "title": "InvestmentsTaxes.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "investment", "entities" ] }, "scope": { "$ref": "#/components/schemas/InvestmentsTaxes.ScopeFilter" } } }, "InvestmentsTaxes.Filter": { "type": "object", "title": "InvestmentsTaxes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "InvestmentsTaxes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "taxYear": { "type": "boolean" }, "status": { "type": "boolean" }, "investorIdentitiesId": { "type": "boolean" }, "investorLegalName": { "type": "boolean" }, "investorTaxId": { "type": "boolean" }, "investorStreetAddress": { "type": "boolean" }, "investorCity": { "type": "boolean" }, "investorState": { "type": "boolean" }, "investorPostalCode": { "type": "boolean" }, "investorIsUsDomestic": { "type": "boolean" }, "investorFcAndSoiAndDApplicable": { "type": "boolean" }, "investorOtherDeductions": { "type": "boolean" }, "investorContributions": { "type": "boolean" }, "investorDistributions": { "type": "boolean" }, "dealId": { "type": "boolean" }, "investorEntityType": { "type": "boolean" }, "investorEntityIsDisregarded": { "type": "boolean" }, "investorDisregardedOwnerName": { "type": "boolean" }, "investorDisregardedOwnerTaxId": { "type": "boolean" }, "investorBeginningProfitPercentage": { "type": "boolean" }, "investorBeginningLossPercentage": { "type": "boolean" }, "investorBeginningCapitalPercentage": { "type": "boolean" }, "investorForeignTaxCreditLimitationApplicable": { "type": "boolean" }, "investorCountry": { "type": "boolean" }, "investorEndingProfitPercentage": { "type": "boolean" }, "investorEndingLossPercentage": { "type": "boolean" }, "investorEndingCapitalPercentage": { "type": "boolean" }, "k1FilesId": { "type": "boolean" }, "investorOwnershipPercent": { "type": "boolean" }, "investorCurrentYearNetIncomeLoss": { "type": "boolean" }, "investorEndingCapitalAccountAmount": { "type": "boolean" }, "investorBeginningCapitalAccountAmount": { "type": "boolean" }, "legacyRecordId": { "type": "boolean" }, "calculatorVersion": { "type": "boolean" }, "partnerIndex": { "type": "boolean" }, "investorEmail": { "type": "boolean" }, "lastPrintedAt": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "investmentId": { "type": "boolean" }, "entityId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "taxYear", "status", "investorIdentitiesId", "investorLegalName", "investorTaxId", "investorStreetAddress", "investorCity", "investorState", "investorPostalCode", "investorIsUsDomestic", "investorFcAndSoiAndDApplicable", "investorOtherDeductions", "investorContributions", "investorDistributions", "dealId", "investorEntityType", "investorEntityIsDisregarded", "investorDisregardedOwnerName", "investorDisregardedOwnerTaxId", "investorBeginningProfitPercentage", "investorBeginningLossPercentage", "investorBeginningCapitalPercentage", "investorForeignTaxCreditLimitationApplicable", "investorCountry", "investorEndingProfitPercentage", "investorEndingLossPercentage", "investorEndingCapitalPercentage", "k1FilesId", "investorOwnershipPercent", "investorCurrentYearNetIncomeLoss", "investorEndingCapitalAccountAmount", "investorBeginningCapitalAccountAmount", "legacyRecordId", "calculatorVersion", "partnerIndex", "investorEmail", "lastPrintedAt", "createdAt", "updatedAt", "investmentId", "entityId" ], "example": "id" }, "uniqueItems": true } ], "title": "InvestmentsTaxes.Fields" }, "include": { "title": "InvestmentsTaxes.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/InvestmentsTaxes.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Invoices.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Invoices.ScopeFilter" }, "Invoices.IncludeFilter.Items": { "title": "Invoices.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "deal", "entity", "organization", "lineItems" ] }, "scope": { "$ref": "#/components/schemas/Invoices.ScopeFilter" } } }, "Invoices.Filter": { "type": "object", "title": "Invoices.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "type": { "type": "boolean" }, "invoiceNumber": { "type": "boolean" }, "reference": { "type": "boolean" }, "status": { "type": "boolean" }, "date": { "type": "boolean" }, "dueDate": { "type": "boolean" }, "expectedPaymentDate": { "type": "boolean" }, "plannedPaymentDate": { "type": "boolean" }, "subTotal": { "type": "boolean" }, "totalTax": { "type": "boolean" }, "total": { "type": "boolean" }, "totalDiscount": { "type": "boolean" }, "amountDue": { "type": "boolean" }, "amountPaid": { "type": "boolean" }, "amountCredited": { "type": "boolean" }, "currencyCode": { "type": "boolean" }, "currencyRate": { "type": "boolean" }, "contactName": { "type": "boolean" }, "contactId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "providerData": { "type": "boolean" }, "lastSuccessfulSync": { "type": "boolean" }, "syncStatus": { "type": "boolean" }, "dealId": { "type": "boolean" }, "entityId": { "type": "boolean" }, "organizationId": { "type": "boolean" }, "sentToContact": { "type": "boolean" }, "url": { "type": "boolean" }, "lineAmountTypes": { "type": "boolean" }, "brandingThemeId": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "type", "invoiceNumber", "reference", "status", "date", "dueDate", "expectedPaymentDate", "plannedPaymentDate", "subTotal", "totalTax", "total", "totalDiscount", "amountDue", "amountPaid", "amountCredited", "currencyCode", "currencyRate", "contactName", "contactId", "provider", "providerId", "providerData", "lastSuccessfulSync", "syncStatus", "dealId", "entityId", "organizationId", "sentToContact", "url", "lineAmountTypes", "brandingThemeId", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Invoices.Fields" }, "include": { "title": "Invoices.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Invoices.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Invoices.Filter1": { "type": "object", "title": "Invoices.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Invoices.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "deleted": { "type": "boolean" }, "deletedOn": { "type": "boolean" }, "deletedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "type": { "type": "boolean" }, "invoiceNumber": { "type": "boolean" }, "reference": { "type": "boolean" }, "status": { "type": "boolean" }, "date": { "type": "boolean" }, "dueDate": { "type": "boolean" }, "expectedPaymentDate": { "type": "boolean" }, "plannedPaymentDate": { "type": "boolean" }, "subTotal": { "type": "boolean" }, "totalTax": { "type": "boolean" }, "total": { "type": "boolean" }, "totalDiscount": { "type": "boolean" }, "amountDue": { "type": "boolean" }, "amountPaid": { "type": "boolean" }, "amountCredited": { "type": "boolean" }, "currencyCode": { "type": "boolean" }, "currencyRate": { "type": "boolean" }, "contactName": { "type": "boolean" }, "contactId": { "type": "boolean" }, "provider": { "type": "boolean" }, "providerId": { "type": "boolean" }, "providerData": { "type": "boolean" }, "lastSuccessfulSync": { "type": "boolean" }, "syncStatus": { "type": "boolean" }, "dealId": { "type": "boolean" }, "entityId": { "type": "boolean" }, "organizationId": { "type": "boolean" }, "sentToContact": { "type": "boolean" }, "url": { "type": "boolean" }, "lineAmountTypes": { "type": "boolean" }, "brandingThemeId": { "type": "boolean" }, "notes": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "deleted", "deletedOn", "deletedBy", "createdAt", "updatedAt", "type", "invoiceNumber", "reference", "status", "date", "dueDate", "expectedPaymentDate", "plannedPaymentDate", "subTotal", "totalTax", "total", "totalDiscount", "amountDue", "amountPaid", "amountCredited", "currencyCode", "currencyRate", "contactName", "contactId", "provider", "providerId", "providerData", "lastSuccessfulSync", "syncStatus", "dealId", "entityId", "organizationId", "sentToContact", "url", "lineAmountTypes", "brandingThemeId", "notes" ], "example": "id" }, "uniqueItems": true } ], "title": "Invoices.Fields" }, "include": { "title": "Invoices.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Invoices.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "tags": [ { "name": "Documents", "description": "Document Generation and Storage" }, { "name": "Organizations", "description": "Client Information and Account Grouping" }, { "name": "Files", "description": "File Storage and Retrieval" }, { "name": "Entities", "description": "Legal Structures for SPVs and Funds" }, { "name": "Identities", "description": "Representations of Individuals and Corporations" }, { "name": "Deals", "description": "SPVs and Funds" }, { "name": "Investments", "description": "Investment details" }, { "name": "Static References", "description": "Standard Data References to be used with other objects" }, { "name": "Banking", "description": "Currency storage and movement" }, { "name": "Notifications", "description": "Call-to-actions and informational data" }, { "name": "Support Tickets", "description": "Engage the Allocations support team" }, { "name": "Taxes", "description": "Deal and Entity related taxes" } ], "security": [ { "jwt": [] } ], "servers": [ { "url": "https://api.allocations.com" } ] }