{ "openapi": "3.0.1", "info": { "title": "Fenergo Nebula Deals Query", "description": "**Deals Query API**:


Deals Query API provides endpoints in order to retrieve all related models and their versions.

", "version": "1.0" }, "servers": [ { "url": "/dealsquery" } ], "paths": { "/api/deals/drafts/{dealDraftId}": { "get": { "tags": [ "DealDraft" ], "summary": "Get Deal Draft By Id", "description": "

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetDealDraftById", "parameters": [ { "name": "dealDraftId", "in": "path", "description": "Deal Draft Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Single Deal Draft is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDraftDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal Draft with given Id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/drafts/journey/{journeyId}": { "get": { "tags": [ "DealDraft" ], "summary": "Get Deal Drafts By Journey Id", "description": "

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetDealDraftsByJourneyId", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of Deal Drafts is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDraftDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Journey with given Id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals": { "get": { "tags": [ "Deals" ], "summary": "Get All Deals", "description": "

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetAllDeals", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of Deals is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/{dealId}": { "get": { "tags": [ "Deals" ], "summary": "Get Deal By Id", "description": "

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetDealById", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Single Deal is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "Deals" ], "summary": "Get a deals snapshot", "description": "\nThis method retrieves an object containing lists of deals and drafts from S3 for a given taskId

Required permissions:
Following permissions are required: DealAccessAndSearch", "operationId": "GetDealsSnapshot", "parameters": [ { "name": "journeyId", "in": "path", "description": "The id of a journey that the deals belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "The id of a task that the deals belong to", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsSnapshotDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the query" }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/entity/{entityId}": { "get": { "tags": [ "Deals" ], "summary": "Get Verified Deals by Entity ID", "description": "

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetVerifiedDealsByEntityId", "parameters": [ { "name": "entityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of Deals is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/related-deals/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "Deals" ], "summary": "Get Related Deals Data Source", "description": "\nGets related deals data source

Required permissions:
Following permissions are required: DealAccessAndSearch", "operationId": "GetRelatedDealsDataSource", "parameters": [ { "name": "entityId", "in": "path", "description": "The Id of the existing Entity", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The Id of the existing Journey", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "The created Fenergo.Nebula.Deals.Query.Application.Dto.GetRelatedDealsDataSource.GetRelatedDealsDataSourceResponseDto containing related deals", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRelatedDealsDataSourceResponseDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "500": { "description": "An exception occurred while processing the request" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/{dealId}/pre-sign-urls": { "post": { "tags": [ "Deals" ], "summary": "Get pre-sign URLs for a file identifiers\r\nThis endpoint is intended for use with the new DataField type - RichTextEditor.", "description": "\nReturns URLs for each file identifier

Required permissions:
At least one of the following permissions is required: DealAccessAndSearch", "operationId": "GetPreSignUrlForFileIdentifiers", "parameters": [ { "name": "dealId", "in": "path", "description": "Deal id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "File identifiers request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlForFileIdentifiersRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Instance of property is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPreSignUrlForFileIdentifiersResponseDtoServiceResponse" } } } }, "403": { "description": "Forbidden. User has no access to reveal property", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal or PropertyName with given id/name does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "Deals" ], "summary": "Get all verified and draft deals for the current journey", "description": "\nReturns all verified and draft deals for the current journey given an entityId and journeyId.

Required permissions:
Following permissions are required: DealAccessAndSearch", "operationId": "GetAllDealsForEntityJourney", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A list of all deals is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealJourneyDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/deals/external-calculations/calculate-property-value": { "post": { "tags": [ "ExternalCalculations" ], "summary": "Get calculated value for property", "description": "\nThis method calculates property value.", "operationId": "GetCalculatedPropertyValue", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Request for external property value", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CalculatedPropertyValueRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Response is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculatedPropertyValueResponseDtoServiceResponse" } } } }, "400": { "description": "Bad RequestedData. The RequestedData has missing/invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set": { "get": { "tags": [ "RequirementSet" ], "summary": "Get Requirement Sets", "description": "

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetAllRequirementSets", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of requirement sets is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/{requirementSetId}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get deals requirement sets by Id", "description": "

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetRequirementSetById", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/{requirementSetId}/version/active": { "get": { "tags": [ "RequirementSet" ], "summary": "Get current active requirement set version", "description": "

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetActiveRequirementSetVersion", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/{requirementSetId}/version/{versionNumber}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get deal requirement set by id and version", "description": "\nReturns deal requirement set for a given id and version number.

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetRequirementSetByIdVersionNumber", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Deal requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Deal requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Deal requirement set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementSetVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Deal requirement set with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/{requirementSetId}/version/{versionNumber}/field/{id}": { "get": { "tags": [ "RequirementSet" ], "summary": "Get requirement by id", "description": "\nReturns requirement by given requirement set id, requirement set version number and requirement id.

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetRequirementById", "parameters": [ { "name": "requirementSetId", "in": "path", "description": "Requirement set id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Requirement set version number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "Requirement id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Requirement is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequirementDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Requirement set/requirement with given id/version does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/evaluate-requirements": { "post": { "tags": [ "RequirementSet" ], "summary": "Evaluate all requirements", "description": "\nRecommended way to get all evaluated requirements (conditional and not) for a given parameters.

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "EvaluateRequirements", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Evaluate all requirements request with a set of criteria to filter requirements and evaluate conditions.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Response is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/evaluate-requirements/read-only": { "post": { "tags": [ "RequirementSet" ], "summary": "Evaluate all requirements in read-only status. Call this endpoint when task is completed, it will skip calculation.", "description": "\nRecommended way to get all evaluated requirements (conditional and not) for a given parameters.

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "EvaluateRequirementsReadonly", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "description": "Evaluate all requirements request with a set of criteria to filter requirements and evaluate conditions, but it will skip calculation", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/EvaluateAllRequirementsRequestDtoServiceRequest" } ] } } } }, "responses": { "200": { "description": "Success. Response is returned.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EvaluatedAllRequirementsResponseDtoServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/requirement-set/requirements-data-source": { "get": { "tags": [ "RequirementSet" ], "summary": "Get Requirements Data Source", "description": "

Required permissions:
At least one of the following permissions is required: DealConfigurationAccess, DealAccessAndSearch", "operationId": "GetRequirementsDataSource", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. List of requirements is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccountRelatedFundDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "AccountRelatedFundsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "accountRelatedFunds": { "type": "array", "items": { "$ref": "#/components/schemas/AccountRelatedFundDto" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AssociationDto": { "type": "object", "properties": { "id": { "type": "string" }, "isVerified": { "type": "boolean" }, "journeyId": { "type": "string" }, "sourceId": { "type": "string" }, "targetId": { "type": "string" }, "type": { "type": "string" } }, "additionalProperties": false }, "AutoCreditAssessmentDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "autoCreditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/AutoCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "AutoCreditScreeningDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "providerInternalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "message": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CalculatedPropertyValueRequestDto": { "type": "object", "properties": { "propertyName": { "type": "string" }, "calculationProperties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "CalculatedPropertyValueRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CalculatedPropertyValueRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "CalculatedPropertyValueResponseDto": { "type": "object", "properties": { "calculatedValue": { "type": "string" } }, "additionalProperties": false }, "CalculatedPropertyValueResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CalculatedPropertyValueResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CalculatedResultDto": { "type": "object", "properties": { "result": { "type": "string", "nullable": true }, "error": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ChangedFieldsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "changedFields": { "type": "array", "items": { "$ref": "#/components/schemas/ChangedFieldDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "collaterals": { "type": "array", "items": { "$ref": "#/components/schemas/CollateralDto" }, "nullable": true } }, "additionalProperties": false }, "CollateralDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "Collection": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "CollectionDto": { "type": "object", "properties": { "isValid": { "type": "boolean" }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "propertiesInfo": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyInfoDto" }, "nullable": true } }, "additionalProperties": false }, "CollectionItemDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "CollectionMaximumCountRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMaximumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "CollectionMinimumCountRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "nullable": true }, "overallMinimumCount": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "CollectionProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Collection" } } }, "additionalProperties": false } ] }, "CollectionPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "collections": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CollectionPropertyDto2": { "type": "object", "properties": { "items": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionItemDto" }, "nullable": true }, "collectionId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "CollectionPropertyInfoDto": { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "value": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "nullable": true }, "valueType": { "type": "string", "nullable": true }, "dataSource": { "type": "string", "nullable": true }, "operation": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "nullable": true } }, "additionalProperties": false }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true } }, "additionalProperties": false }, "ConditionalValueDto": { "allOf": [ { "$ref": "#/components/schemas/StringConditionalValueDto" }, { "type": "object", "properties": { "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "ConditionalValueDto`1": { "allOf": [ { "$ref": "#/components/schemas/ConditionDto" }, { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/T`1" } ], "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false } ] }, "CreditAssessmentDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "assessmentOutcome": { "type": "string", "nullable": true }, "assessmentComment": { "type": "string", "nullable": true }, "taskId": { "type": "string", "nullable": true }, "taskDataKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentDataGroupItemDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "CurrentFieldDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "currentField": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CurrentJourneysDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "inProgressJourneyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "CurrentProductDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CustomPropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "customTypeId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false } ] }, "CustomPropertyDto2": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "propertyType": { "type": "string" }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "formulaSchema": { "allOf": [ { "$ref": "#/components/schemas/FormulaSchemaDto" } ], "nullable": true } }, "additionalProperties": false }, "DataFieldSummaryDto": { "type": "object", "properties": { "propertyType": { "type": "string" }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "categories": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "requirementSetsNames": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "names": { "uniqueItems": true, "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "DataSourcesDto": { "type": "object", "properties": { "entityDataMetadata": { "allOf": [ { "$ref": "#/components/schemas/EntityDataMetadataDataSource" } ], "nullable": true }, "eventIngress": { "allOf": [ { "$ref": "#/components/schemas/EventIngressDataSource" } ], "nullable": true }, "changedFields": { "allOf": [ { "$ref": "#/components/schemas/ChangedFieldsDataSource" } ], "nullable": true }, "relatedClient": { "allOf": [ { "$ref": "#/components/schemas/RelatedClientDataSource" } ], "nullable": true }, "relatedProducts": { "allOf": [ { "$ref": "#/components/schemas/RelatedProductsDataSource" } ], "nullable": true }, "currentDataGroupItem": { "allOf": [ { "$ref": "#/components/schemas/CurrentDataGroupItemDataSource" } ], "nullable": true }, "externalDataAdapter": { "allOf": [ { "$ref": "#/components/schemas/ExternalDataAdapterDataSource" } ], "nullable": true }, "entityAssociation": { "allOf": [ { "$ref": "#/components/schemas/EntityAssociationDataSource" } ], "nullable": true }, "manualCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditAssessmentV2DataSource" } ], "nullable": true }, "autoCreditAssessment": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditAssessmentDataSource" } ], "nullable": true }, "manualCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/ManualCreditScreeningDataSource" } ], "nullable": true }, "collateral": { "allOf": [ { "$ref": "#/components/schemas/CollateralDataSource" } ], "nullable": true }, "currentJourneys": { "allOf": [ { "$ref": "#/components/schemas/CurrentJourneysDataSource" } ], "nullable": true }, "autoCreditScreening": { "allOf": [ { "$ref": "#/components/schemas/AutoCreditScreeningDataSource" } ], "nullable": true }, "currentProduct": { "allOf": [ { "$ref": "#/components/schemas/CurrentProductDataSource" } ], "nullable": true }, "relatedDeals": { "allOf": [ { "$ref": "#/components/schemas/RelatedDealsDataSource" } ], "nullable": true }, "mainEntity": { "allOf": [ { "$ref": "#/components/schemas/MainEntityDataSource" } ], "nullable": true }, "relatedAssets": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssetsDataSource" } ], "nullable": true }, "relatedAssociations": { "allOf": [ { "$ref": "#/components/schemas/RelatedAssociationsDataSource" } ], "nullable": true }, "accountRelatedFunds": { "allOf": [ { "$ref": "#/components/schemas/AccountRelatedFundsDataSource" } ], "nullable": true }, "journeyLevelData": { "allOf": [ { "$ref": "#/components/schemas/JourneyLevelDataDataSource" } ], "nullable": true }, "relatedParties": { "allOf": [ { "$ref": "#/components/schemas/RelatedPartiesDataSource" } ], "nullable": true }, "currentField": { "allOf": [ { "$ref": "#/components/schemas/CurrentFieldDataSource" } ], "nullable": true }, "significanceEngine": { "allOf": [ { "$ref": "#/components/schemas/SignificanceEngineDataSource" } ], "nullable": true } }, "additionalProperties": false }, "DateLimitRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "minDate": { "type": "string", "format": "date-time", "nullable": true }, "maxDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false } ] }, "Deal": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true }, "isDeleted": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DealDraft": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tenant": { "type": "string", "nullable": true }, "version": { "type": "integer", "format": "int32" }, "isLocked": { "type": "boolean" }, "dealId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true }, "isDeleted": { "type": "boolean" }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DealDraftDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dealId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true }, "version": { "type": "integer", "format": "int32" }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "DealDraftDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealDraftDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DealDraftDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DealDraftDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DealDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true }, "version": { "type": "integer", "format": "int32" }, "created": { "type": "string", "format": "date-time" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DealDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DealDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DealDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DealJourneyDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dealDraftId": { "type": "string", "format": "uuid", "nullable": true }, "entityId": { "type": "string", "format": "uuid" }, "journeyId": { "type": "string", "format": "uuid" }, "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetVersion": { "type": "integer", "format": "int32" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Property" }, "nullable": true }, "version": { "type": "integer", "format": "int32" }, "created": { "type": "string", "format": "date-time" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DealJourneyDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DealJourneyDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DealPropertyType": { "enum": [ "Single", "Group", "Collection" ], "type": "string" }, "DealsSnapshotDto": { "type": "object", "properties": { "associatedProducts": { "type": "array", "items": { "$ref": "#/components/schemas/SnapshotProduct" }, "nullable": true }, "dealProductAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/AssociationDto" }, "nullable": true }, "dealDrafts": { "type": "array", "items": { "$ref": "#/components/schemas/DealDraft" }, "nullable": true }, "verifiedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/Deal" }, "nullable": true } }, "additionalProperties": false }, "DealsSnapshotDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DealsSnapshotDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "EntityAssociationDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "EntityDataMetadataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluateAllRequirementsRequestDto": { "type": "object", "properties": { "requirementSetId": { "type": "string" }, "version": { "type": "integer", "format": "int32" }, "requirementType": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" } }, "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ] }, "categories": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "EvaluateAllRequirementsRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluateAllRequirementsRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "EvaluatedAllRequirementsResponseDto": { "type": "object", "properties": { "allEvaluatedDataRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataFieldDto" } }, "evaluatedSingleDataRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataFieldDto" } }, "evaluatedDataGroupRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupRequirementDto" } }, "evaluatedDocumentRequirements": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDocumentRequirementDto" } } }, "additionalProperties": false }, "EvaluatedAllRequirementsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EvaluatedAllRequirementsResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EvaluatedDataFieldDto": { "type": "object", "properties": { "requirementSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32" }, "propertyName": { "type": "string", "nullable": true }, "propertyType": { "type": "string", "nullable": true }, "propertyTypeId": { "type": "string", "format": "uuid", "nullable": true }, "linkChildFieldPropertyName": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isReadOnly": { "type": "boolean" }, "category": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true }, "isRequired": { "type": "boolean" }, "order": { "type": "number", "format": "double", "nullable": true }, "isSecondaryIdentifier": { "type": "boolean" }, "secondaryIdentifierOrder": { "type": "number", "format": "double", "nullable": true }, "hasEvaluatedConditionalValue": { "type": "boolean" }, "evaluatedConditionalValue": { "type": "string", "nullable": true }, "hasEvaluatedDefaultValue": { "type": "boolean" }, "uiDecoration": { "type": "string", "nullable": true }, "defaultDateType": { "type": "string", "nullable": true }, "hasCalculatedValue": { "type": "boolean" }, "calculatedFieldResult": { "allOf": [ { "$ref": "#/components/schemas/CalculatedResultDto" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EvaluatedDataGroupFieldDto": { "allOf": [ { "$ref": "#/components/schemas/EvaluatedDataFieldDto" }, { "type": "object", "additionalProperties": false } ] }, "EvaluatedDataGroupItemDto": { "type": "object", "properties": { "evaluatedFields": { "type": "array", "items": { "$ref": "#/components/schemas/EvaluatedDataGroupFieldDto" } } }, "additionalProperties": false }, "EvaluatedDataGroupRequirementDto": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "dataGroupId": { "type": "string", "format": "uuid" }, "evaluatedItems": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EvaluatedDataGroupItemDto" }, "nullable": true }, "category": { "type": "string", "nullable": true }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "dataGroupVersionNumber": { "type": "integer", "format": "int32", "nullable": true }, "dataGroupName": { "type": "string", "nullable": true }, "primaryDataGroupField": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "isReadOnly": { "type": "boolean" } }, "additionalProperties": false }, "EvaluatedDocumentRequirementDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "dataKey": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "category": { "type": "string", "nullable": true }, "isRequired": { "type": "boolean" } }, "additionalProperties": false }, "EventIngressDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalDataAdapterDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "eventType": { "type": "string", "nullable": true }, "eventSubtype": { "type": "string", "nullable": true } }, "additionalProperties": false }, "FilterConditionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaSchemaDto": { "type": "object", "properties": { "formulaSetId": { "type": "string", "format": "uuid" }, "versionNumber": { "type": "integer", "format": "int32", "nullable": true }, "formulaString": { "type": "string" }, "formulaVariables": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FormulaVariableDto" }, "nullable": true } }, "additionalProperties": false }, "FormulaVariableDto": { "type": "object", "properties": { "dataSource": { "type": "string" }, "propertyName": { "type": "string" }, "filterConditions": { "type": "array", "items": { "$ref": "#/components/schemas/FilterConditionDto" }, "nullable": true } }, "additionalProperties": false }, "GetMergedRequirementSetsDataFieldsResponseDto": { "type": "object", "properties": { "dataFieldsByPropertyName": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DataFieldSummaryDto" } } }, "additionalProperties": false }, "GetMergedRequirementSetsDataFieldsResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetMergedRequirementSetsDataFieldsResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetPreSignUrlForFileIdentifiersRequestDto": { "type": "object", "properties": { "isRootContent": { "type": "boolean" }, "dataKey": { "type": "string" }, "fileIdentifiers": { "type": "array", "items": { "type": "string" } }, "dealDraftId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "GetPreSignUrlForFileIdentifiersRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlForFileIdentifiersRequestDto" } ], "nullable": true } }, "additionalProperties": false }, "GetPreSignUrlForFileIdentifiersResponseDto": { "type": "object", "properties": { "isRootContent": { "type": "boolean" }, "urls": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false }, "GetPreSignUrlForFileIdentifiersResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetPreSignUrlForFileIdentifiersResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetRelatedDealsDataSourceResponseDto": { "type": "object", "properties": { "dataSources": { "allOf": [ { "$ref": "#/components/schemas/DataSourcesDto" } ] } }, "additionalProperties": false }, "GetRelatedDealsDataSourceResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetRelatedDealsDataSourceResponseDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GroupProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "dataGroupId": { "type": "string", "format": "uuid" }, "properties": { "type": "object", "additionalProperties": { "type": "string" } } }, "additionalProperties": false } ] }, "HttpValidationProblemDetails": { "allOf": [ { "$ref": "#/components/schemas/ProblemDetails" }, { "type": "object", "properties": { "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "additionalProperties": { } } ] }, "JourneyLevelDataDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "MainEntityDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "ManualCreditAssessmentV2DataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditAssessments": { "type": "array", "items": { "$ref": "#/components/schemas/CreditAssessmentDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "creditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true }, "relatedPartyCreditScreenings": { "type": "array", "items": { "$ref": "#/components/schemas/ManualCreditScreeningDto" }, "nullable": true } }, "additionalProperties": false }, "ManualCreditScreeningDto": { "type": "object", "properties": { "taskDataKey": { "type": "string", "nullable": true }, "taskId": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "creditScreeningOutcome": { "type": "string", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "PropertiesDto": { "type": "object", "properties": { "singleProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto2" }, "nullable": true }, "collectionProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CollectionPropertyDto2" }, "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/CustomPropertyDto2" }, "nullable": true } }, "additionalProperties": false }, "Property": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "allOf": [ { "$ref": "#/components/schemas/DealPropertyType" } ], "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/DealPropertyType" } ], "readOnly": true } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "Collection": "#/components/schemas/CollectionProperty", "Group": "#/components/schemas/GroupProperty", "Single": "#/components/schemas/SingleProperty" } } }, "PropertyDto": { "required": [ "discriminator" ], "type": "object", "properties": { "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false, "discriminator": { "propertyName": "discriminator", "mapping": { "Collection": "#/components/schemas/CollectionPropertyDto", "Custom": "#/components/schemas/CustomPropertyDto", "Single": "#/components/schemas/SinglePropertyDto" } } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "RegexRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "isCaseSensitive": { "type": "boolean" }, "regexValue": { "type": "string" } }, "additionalProperties": false } ] }, "RelatedAssetDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssetsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "assets": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssetDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedAssociationDto": { "type": "object", "properties": { "associationType": { "type": "string", "nullable": true }, "ownershipPercentage": { "type": "number", "format": "double", "nullable": true }, "associationToClient": { "type": "string", "nullable": true }, "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true } }, "additionalProperties": false }, "RelatedAssociationsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedAssociationDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedClientDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedDealsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedDeals": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedDealDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartiesDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "relatedParties": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedPartyDto" }, "nullable": true } }, "additionalProperties": false }, "RelatedPartyDto": { "type": "object", "properties": { "properties": { "allOf": [ { "$ref": "#/components/schemas/PropertiesDto" } ], "nullable": true }, "metadata": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true } }, "additionalProperties": false }, "RelatedProductDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "nullable": true }, "lifecycleStatus": { "type": "string", "nullable": true }, "relationshipTypes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelatedProductsDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedProductDto" }, "nullable": true } }, "additionalProperties": false }, "RequirementDto": { "type": "object", "properties": { "requirementSetId": { "type": "string", "format": "uuid" }, "requirementSetName": { "type": "string", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32" }, "id": { "type": "string", "format": "uuid" }, "category": { "type": "string" }, "description": { "type": "string", "nullable": true }, "name": { "type": "string" }, "classification": { "type": "string", "nullable": true }, "tags": { "type": "array", "items": { "type": "string" } }, "type": { "type": "string" }, "dataField": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "nullable": true }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "nullable": true }, "order": { "type": "number", "format": "double", "nullable": true }, "defaultValue": { "type": "string", "nullable": true }, "isSecondaryIdentifier": { "type": "boolean" }, "isReadOnly": { "type": "boolean" }, "secondaryIdentifierOrder": { "type": "number", "format": "double", "nullable": true }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "nullable": true }, "conditionalValues": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionalValueDto" }, "nullable": true }, "documentDescription": { "type": "string", "nullable": true }, "documentDataKey": { "type": "string", "nullable": true }, "isMandatory": { "type": "boolean" }, "version": { "type": "integer", "format": "int32" }, "uiDecoration": { "type": "string", "nullable": true }, "defaultDateType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RequirementDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RequirementSetDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "format": "int32" }, "jurisdiction": { "type": "string" }, "status": { "type": "string" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementSetVersionDto" } } }, "additionalProperties": false }, "RequirementSetDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementSetDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RequirementSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "RequirementSetVersionDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "setId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "effectiveFrom": { "type": "string", "format": "date-time" }, "effectiveUntil": { "type": "string", "format": "date-time", "nullable": true }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ] }, "notes": { "type": "string", "nullable": true }, "versionNumber": { "type": "integer", "format": "int32" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "nullable": true }, "version": { "type": "integer", "format": "int32" }, "requirements": { "type": "array", "items": { "$ref": "#/components/schemas/RequirementDto" } }, "jurisdiction": { "type": "string" } }, "additionalProperties": false }, "RequirementSetVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/RequirementSetVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SignificanceEngineDataSource": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true, "readOnly": true }, "significanceEngine": { "type": "array", "items": { "$ref": "#/components/schemas/SignificanceEngineDto" }, "nullable": true } }, "additionalProperties": false }, "SignificanceEngineDto": { "type": "object", "properties": { "key": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SingleProperty": { "allOf": [ { "$ref": "#/components/schemas/Property" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto": { "allOf": [ { "$ref": "#/components/schemas/PropertyDto" }, { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false } ] }, "SinglePropertyDto2": { "type": "object", "properties": { "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SnapshotProduct": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "family": { "type": "string" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" } }, "entityId": { "type": "string" }, "status": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SpecialCharactersRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "excludedCharacters": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } ] }, "StringConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "logicalOperation": { "type": "string", "nullable": true }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "T`1": { "type": "object", "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "specialCharacters": { "allOf": [ { "$ref": "#/components/schemas/SpecialCharactersRuleDto" } ], "nullable": true }, "noNumbers": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "regex": { "allOf": [ { "$ref": "#/components/schemas/RegexRuleDto" } ], "nullable": true }, "characterLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "noFutureDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "noPastDates": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "disallowTodaysDate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "nullable": true }, "dateLimit": { "allOf": [ { "$ref": "#/components/schemas/DateLimitRuleDto" } ], "nullable": true }, "multiSelectLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "nullable": true }, "timeZoneId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValidationRuleDto": { "type": "object", "properties": { "propertyName": { "type": "string" }, "friendlyName": { "type": "string" }, "validationType": { "type": "string" }, "validationData": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ] } }, "additionalProperties": false }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "nullable": true }, "field": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValueLimitRuleDto": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" }, { "type": "object", "properties": { "minValue": { "type": "integer", "format": "int32", "nullable": true }, "maxValue": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false } ] }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }