{ "openapi": "3.0.4", "info": { "title": "Fenergo Financial Analysis Command API", "description": "**Fenergo Financial Analysis Command API**:\n\n
Financial Analysis Command API provides both configurational and operational methods related to the client financial analysis. Use the Financial Analysis Command API to create and update new and existing financial analysis data. Use the Query API to retrieve financial analysis data.\n\n
**Financial Analysis Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/financialanalysiscommand" } ], "paths": { "/api/allocation": { "post": { "tags": [ "Allocation" ], "summary": "Create a new Capacity to Service Set", "description": "\nCreates a new Capacity to Service Set for the Journey.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateAllocationSet", "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": "Create Capacity to Service Set request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationSetDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Capacity to Service Set created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/allocation/{setId}/version": { "post": { "tags": [ "Allocation" ], "summary": "Create a new Capacity to Service Version and Capacity to Service Schema", "description": "\nThis method creates a new Capacity to Service Version based on the previous completed version.\n\nIt also generates the Capacity to Service Schema based on the input and save it to s3.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateAllocationVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Capacity to Service 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" } ], "requestBody": { "description": "ServiceRequest with the schema snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationSchemaRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Set with given ID does not exists", "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/allocation/{setId}/{id}": { "put": { "tags": [ "Allocation" ], "summary": "Update a Capacity to Service Version", "description": "\nThis method updates an existing Capacity to Service Version.\n\nOnly Capacity to Service Version with draft status can be updated.\n\nOnly Capacity to Service Version that satisfies non-mandatory validation rules can be updated.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateAllocationVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Capacity to Service Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Capacity to Service Version 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": "Capacity to Service Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service with given ID does not exists", "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/allocation/{setId}/{id}/status": { "put": { "tags": [ "Allocation" ], "summary": "Update a Capacity to Service Version status", "description": "\nThis method updates an existing Capacity to Service Version status.\n\nOnly Capacity to Service Version with draft status can be updated.\n\nOnly Capacity to Service Version that satisfies validation rules can be completed.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateAllocationStatus", "parameters": [ { "name": "setId", "in": "path", "description": "Capacity to Service Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Capacity to Service Version 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": "Status body: Draft, Completed, Rejected, Verified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Set with given ID does not exists", "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/allocation/{setId}/{id}/schema": { "put": { "tags": [ "Allocation" ], "summary": "Update a Capacity to Service Schema", "description": "\nThis method generates Capacity to Service Schema based on the input and policy configuration.\n\nIt updates or creates Capacity to Service Schema associated to the Set and Version Id in s3.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateAllocationSchema", "parameters": [ { "name": "setId", "in": "path", "description": "Capacity to Service Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Capacity to Service Version 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": "Update Capacity to Service Schema request Fenergo.Nebula.FinancialAnalysis.Command.Application.Dto.RetrieveSchemaDto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationSchemaRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Capacity to Service Schema updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationSchemaDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/configuration/allocation": { "post": { "tags": [ "AllocationConfiguration" ], "summary": "Create a new Capacity to Service Configuration", "description": "\nCreates a new Capacity to Service Configuration

Required permissions:
Following permissions are required: AllocationConfigurationCreate", "operationId": "CreateAllocationConfiguration", "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": "Create Capacity to Service Configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Capacity to Service Configuration created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/configuration/allocation/{configurationId}": { "delete": { "tags": [ "AllocationConfiguration" ], "summary": "Delete Capacity to Service Configuration and all it's versions", "description": "\nThis method deletes an existing Capacity to Service Configuration as well as all its versions.

Required permissions:
Following permissions are required: AllocationConfigurationDelete", "operationId": "DeleteAllocationConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "Configuration 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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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" } ] } } } } } }, "post": { "tags": [ "AllocationConfiguration" ], "summary": "Create a new Version for an existing Capacity to Service Configuration", "description": "\nThis method creates a new Capacity to Service Configuration version.\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\n the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: AllocationConfigurationCreate", "operationId": "CreateAllocationConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the new version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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/configuration/allocation/{configurationId}/version/{versionNumber}/clone": { "post": { "tags": [ "AllocationConfiguration" ], "summary": "Clone a Capacity to Service Configuration", "description": "

Required permissions:
Following permissions are required: AllocationConfigurationEdit", "operationId": "CloneAllocationConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "Capacity to Service Configuration Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to clone", "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" } ], "requestBody": { "description": "Clone Capacity to Service Configuration version request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationCloneRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Capacity to Service Configuration cloned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationClonedResponseDtoServiceResponse" } } } }, "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. Capacity to Service Configuration 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/configuration/allocation/{configurationId}/version/{versionNumber}": { "put": { "tags": [ "AllocationConfiguration" ], "summary": "Updates an existing Version of a Capacity to Service Configuration", "description": "\nThis method updates an existing Capacity to Service Configuration version.\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: AllocationConfigurationEdit", "operationId": "UpdateAllocationConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Number of version to update", "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" } ], "requestBody": { "description": "ServiceRequest with the updated version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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/configuration/allocation/{configurationId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "AllocationConfiguration" ], "summary": "Submit an existing Version of a Capacity to Service Configuration for Approval", "description": "\nThis method submits the selected version of an existing Capacity to Service Configuration for Approval.

Required permissions:
Following permissions are required: AllocationConfigurationCreate", "operationId": "SubmitAllocationConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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/configuration/allocation/{configurationId}/version/{versionNumber}/sign": { "put": { "tags": [ "AllocationConfiguration" ], "summary": "Sign an existing Version of a Capacity to Service Configuration", "description": "\nThis method signs the selected version of an existing Capacity to Service Configuration.\n The Status of the version changes according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: AllocationConfigurationApprove", "operationId": "SignAllocationConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationVersionSignedResponseDtoServiceResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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/configuration/allocation/{configurationId}/version/{versionNumber}/archive": { "put": { "tags": [ "AllocationConfiguration" ], "summary": "Archive an existing Version of a Capacity to Service Configuration", "description": "\nThis method archives the selected version of an existing Capacity to Service Configuration.

Required permissions:
Following permissions are required: AllocationConfigurationArchive", "operationId": "ArchiveAllocationConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Capacity to Service Configuration with given ID does not exists", "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/configuration": { "post": { "tags": [ "Configuration" ], "summary": "Create a new Financial Analysis Configuration", "description": "\nCreates a new Financial Analysis Configuration

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationCreate", "operationId": "CreateConfiguration", "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": "Create Financial Analysis Configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Financial Analysis Configuration created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/configuration/{configurationId}": { "delete": { "tags": [ "Configuration" ], "summary": "Delete Financial Analysis Configuration and all it's versions", "description": "\nThis method deletes an existing Financial Analysis Configuration as well as all its versions.

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationDelete", "operationId": "DeleteConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "Configuration 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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Configuration with given ID does not exists", "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" } ] } } } } } }, "post": { "tags": [ "Configuration" ], "summary": "Create a new Version for an existing Financial Analysis Configuration", "description": "\nThis method creates a new Financial Analysis Configuration version.\n\nThe new version initializes with the DTO data. It is assigned the next available version number,\n the default status of Draft and the Author as the only required Signee.

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationCreate", "operationId": "CreateConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "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": "ServiceRequest with the new version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Configuration with given ID does not exists", "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/configuration/{configurationId}/version/{versionNumber}/clone": { "post": { "tags": [ "Configuration" ], "summary": "Clone a Financial Analysis Configuration", "description": "

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationEdit", "operationId": "CloneConfiguration", "parameters": [ { "name": "configurationId", "in": "path", "description": "Configuration Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Version number to clone", "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" } ], "requestBody": { "description": "Clone Configuration version request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationCloneRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Configuration cloned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationClonedResponseDtoServiceResponse" } } } }, "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. Configuration 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/configuration/{configurationId}/version/{versionNumber}": { "put": { "tags": [ "Configuration" ], "summary": "Updates an existing Version of a Financial Analysis Configuration", "description": "\nThis method updates an existing Financial Analysis Configuration version.\n\nOnly Draft and Rejected versions are allowed to be updated.

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationEdit", "operationId": "UpdateConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "Number of version to update", "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" } ], "requestBody": { "description": "ServiceRequest with the updated version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Configuration with given ID does not exists", "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/configuration/{configurationId}/version/{versionNumber}/submit-for-approval": { "put": { "tags": [ "Configuration" ], "summary": "Submit an existing Version of a Financial Analysis Configuration for Approval", "description": "\nThis method submits the selected version of an existing Configuration for Approval.

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationCreate", "operationId": "SubmitConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to submit", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Configuration with given ID does not exists", "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/configuration/{configurationId}/version/{versionNumber}/sign": { "put": { "tags": [ "Configuration" ], "summary": "Sign an existing Version of a Financial Analysis Configuration", "description": "\nThis method signs the selected version of an existing Financial Analysis Configuration.\n The Status of the version changes according to the action sent (Approve/Reject).

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationApprove", "operationId": "SignConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to sign", "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" } ], "requestBody": { "description": "ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveActionServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionSignedResponseDtoServiceResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Configuration with given ID does not exists", "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/configuration/{configurationId}/version/{versionNumber}/archive": { "put": { "tags": [ "Configuration" ], "summary": "Archive an existing Version of a Financial Analysis Configuration", "description": "\nThis method archives the selected version of an existing Financial Analysis Configuration.

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationArchive", "operationId": "ArchiveConfigurationVersion", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of the existing model", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionNumber", "in": "path", "description": "The version number of the version to archive", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Configuration with given ID does not exists", "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/financialanalysis": { "post": { "tags": [ "FinancialAnalysis" ], "summary": "Create a new Financial Analysis Set", "description": "\nCreates a new Financial Analysis Set for an entity. The request must contain entity id and entity type.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateFinancialAnalysisSet", "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": "Create Financial Analysis Set request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisSetDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Financial Analysis Set created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisSetDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/financialanalysis/joint": { "post": { "tags": [ "FinancialAnalysis" ], "summary": "Initialize a new Joint Financial Analysis", "description": "\nInitialize a new Joint Financial Analysis for a pair of entities. The request must contain entity id and entity type.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "InitializeJointFinancialAnalysis", "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": "Initialize Joint Financial Analysis request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JointFinancialAnalysisInitializeRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Joint Financial Analysis Initialized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JointFinancialAnalysisInitializeResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/financialanalysis/{setId}/version": { "post": { "tags": [ "FinancialAnalysis" ], "summary": "Create a new Financial Analysis Version and Financial Analysis Schema", "description": "\nThis method creates a new Financial Analysis Version based on the previous completed version.\n\nIt also generates the Financial Analysis Schema based on the input and save it to s3.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateFinancialAnalysisVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis 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" } ], "requestBody": { "description": "ServiceRequest with the schema snapshot data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Set with given ID does not exists", "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/financialanalysis/{setId}/{id}": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Version", "description": "\nThis method updates an existing Financial Analysis Version.\n\nOnly Financial Analysis Version with draft status can be updated.\n\nOnly Financial Analysis Version that satisfied non-mandatory validation rules can be updated.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateFinancialAnalysisVersion", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Financial Analysis Version data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis with given ID does not exists", "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/financialanalysis/{setId}/{id}/scenario": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Version's Scenario", "description": "\nThis method updates an existing Financial Analysis Version's Scenario.\n\nOnly Financial Analysis Version with draft status can be updated.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateScenarios", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Financial Analysis Scenario data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Scenario with given ID does not exists", "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/financialanalysis/{setId}/{id}/summary": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Version's Summary", "description": "\nThis method updates an existing Financial Analysis Version's Summary.\n\nOnly Financial Analysis Version with draft status can be updated.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateSummary", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Financial Analysis Summary data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryVersionDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryVersionDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Summary with given ID does not exists", "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/financialanalysis/{setId}/status": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Set status", "description": "\nThis method updates an existing Financial Analysis set status.\n\nOnly Financial Analysis sets with draft status can be updated.\n\nOnly Rejected status will be accepted

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateFinancialAnalysisStatus", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis 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" } ], "requestBody": { "description": "Status body: Rejected, Waived and Draft", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Set with given ID does not exists", "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/financialanalysis/{setId}/{id}/status": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Version status", "description": "This endpoint is obsolete and was terminated on 2025-01-01. This endpoint is obsolete, use Update a Financial Analysis Set status endpoint instead.
\nThis method updates an existing Financial Analysis Version status.\n\nOnly Financial Analysis Version with draft status can be updated.\n\nOnly Financial Analysis Version that satisfied validation rules can be completed.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateFinancialAnalysisStatus", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Status body: Draft, Completed, Rejected, Verified", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Set with given ID does not exists", "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" } ] } } } } }, "deprecated": true } }, "/api/financialanalysis/{setId}/version/{id}/reviewstatus": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Version External Review Status", "description": "\nThis method updates an existing Financial Analysis Version External Review Status.\n\nOnly Financial Analysis Version with draft review status can be updated.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateFinancialAnalysisReviewStatus", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Status body: Pending, Approved", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalReviewStatusDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalReviewStatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Financial Analysis Set with given ID does not exists", "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/financialanalysis/{journeyId}/{taskId}/complete": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Complete all financial analysis sets by task id", "description": "\nThis method will complete all related parties, financial analysis versions and allocation versions for current task.\n\nAll related parties which have open financial versions will be completed.\n\nOnly versions with draft status can be updated.\n\nOnly if all versions satisfy validation rules, they can be completed.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CompleteAllFinancialAnalysisVersions", "parameters": [ { "name": "journeyId", "in": "path", "description": "Journey Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "taskId", "in": "path", "description": "Task 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": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatusDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are no financial analysis set for current task.", "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/financialanalysis/{setId}/{id}/schema": { "put": { "tags": [ "FinancialAnalysis" ], "summary": "Update a Financial Analysis Schema", "description": "\nThis method generates Financial Analysis Schema based on the input and policy configuration.\n\nIt updates or creates Financial Analysis Schema associated to the Set and Version Id in s3.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "UpdateSchema", "parameters": [ { "name": "setId", "in": "path", "description": "Financial Analysis Set Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "description": "Financial Analysis Version 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": "Update Financial Analysis Schema request Fenergo.Nebula.FinancialAnalysis.Command.Application.Dto.RetrieveSchemaDto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Financial Analysis Schema updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisSchemaDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}": { "post": { "tags": [ "Import" ], "summary": "Create a new Financial Import to a Provider", "description": "\nCreates a new Financial Import from the entity, journey, task with the provider.

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateFinancialImport", "parameters": [ { "name": "providerId", "in": "path", "description": "Provider Id to issue a Financial Import", "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": "Create financial import", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Financial import created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportResponseDtoServiceResponse" } } } }, "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" } ] } } } } } }, "put": { "tags": [ "ImportProvider" ], "summary": "Update an existing Import Provider", "description": "\nThis method updates an import Provider.

Required permissions:
Following permissions are required: FinancialImportProviderEdit", "operationId": "UpdateImportProvider", "parameters": [ { "name": "providerId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "ImportProvider" ], "summary": "Delete a Import Provider", "description": "\nThis method delete a Import Provider.

Required permissions:
Following permissions are required: FinancialImportProviderDelete", "operationId": "DeleteImportProvider", "parameters": [ { "name": "providerId", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import": { "post": { "tags": [ "Import" ], "summary": "Create Financial Imports all to eligible providers", "description": "\nCreate Financial Imports all to eligible providers with the entity, journey, task details

Required permissions:
Following permissions are required: FinancialAnalysisEdit", "operationId": "CreateFinancialImportsToAllProviders", "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": "Create financial import", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Financial imports created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportResponseDtoIEnumerableServiceResponse" } } } }, "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/import/provider": { "post": { "tags": [ "ImportProvider" ], "summary": "Create a New Import Provider", "description": "\nCreates a new a Import Provider with configuration details.

Required permissions:
Following permissions are required: FinancialImportProviderCreate", "operationId": "CreateImportProvider", "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": "Create Import Provider Dto", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Import Provider created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImportResponseDtoServiceResponse" } } } }, "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/import/provider/{systemId}/default": { "post": { "tags": [ "ImportProvider" ], "summary": "Create a default provider", "description": "\nThis method creates a default provider of a specified provider id.

Required permissions:
Following permissions are required: FinancialImportProviderCreate", "operationId": "CreateDefaultImportProvider", "parameters": [ { "name": "systemId", "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": { "202": { "description": "Accepted for processing" }, "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": "Invalid 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" } ] } } } }, "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/import/provider/{providerId}/enabled": { "put": { "tags": [ "ImportProvider" ], "summary": "Update whether an Import Provider is enabled", "description": "\nThis method updates whether an import provider is enabled.

Required permissions:
Following permissions are required: FinancialImportProviderEdit", "operationId": "UpdateImportProviderEnabled", "parameters": [ { "name": "providerId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderEnabledRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}/mapping": { "post": { "tags": [ "ImportProvider" ], "summary": "Create a new Import Mapping", "description": "\nThis method saves new Import Mapping.

Required permissions:
Following permissions are required: FinancialImportProviderCreate", "operationId": "CreateImportMapping", "parameters": [ { "name": "providerId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}/mapping/{mappingId}": { "put": { "tags": [ "ImportProvider" ], "summary": "Update an existing Import Mapping", "description": "\nThis method updates an existing Import Mapping.

Required permissions:
Following permissions are required: FinancialImportProviderEdit", "operationId": "UpdateImportMapping", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "mappingId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/mapping/{mappingId}": { "delete": { "tags": [ "ImportProvider" ], "summary": "Delete an existing Import Mapping", "description": "\nThis method deletes an existing Import Mapping.

Required permissions:
Following permissions are required: FinancialImportProviderDelete", "operationId": "DeleteImportMapping", "parameters": [ { "name": "mappingId", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}/adapterSchema": { "post": { "tags": [ "ImportProvider" ], "summary": "Create a new Adapter Schema", "description": "\nThis method saves new Adapter Schema.

Required permissions:
Following permissions are required: FinancialImportProviderCreate", "operationId": "CreateAdapterSchema", "parameters": [ { "name": "providerId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}/adapterSchema/{adapterSchemaId}": { "put": { "tags": [ "ImportProvider" ], "summary": "Update an existing Adapter Schema", "description": "\nThis method update an existing Adapter Schema.

Required permissions:
Following permissions are required: FinancialImportProviderEdit", "operationId": "UpdateAdapterSchema", "parameters": [ { "name": "providerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "adapterSchemaId", "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" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceRequest" } } } }, "responses": { "202": { "description": "Accepted for processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/adapterSchema/{adapterSchemaId}": { "delete": { "tags": [ "ImportProvider" ], "summary": "Delete an existing Adapter Schema", "description": "\nThis method delete an existing Adapter Schema.

Required permissions:
Following permissions are required: FinancialImportProviderDelete", "operationId": "DeleteAdapterSchema", "parameters": [ { "name": "adapterSchemaId", "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": { "202": { "description": "Accepted for processing" }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "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/import/provider/{providerId}/test": { "post": { "tags": [ "ImportProvider" ], "summary": "Test an adapter endpoint", "description": "\nThis method triggers the test of an import provider adapters connection

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "TestImportProvider", "parameters": [ { "name": "providerId", "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": { "202": { "description": "Accepted for processing" }, "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": "Invalid 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" } ] } } } }, "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": { "AdapterConfigurationDto": { "type": "object", "properties": { "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AdapterSchemaDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the schema, the value will be ignored when creating or updating the model", "format": "uuid" }, "providerId": { "type": "string", "description": "Provider Id of the schema", "format": "uuid" }, "schema": { "$ref": "#/components/schemas/SchemaDto" } }, "additionalProperties": false, "description": "Adapter Configuration Dto Schema" }, "AdapterSchemaDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" } }, "additionalProperties": false }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AdapterSchemaDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationConfigurationCloneRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of cloned configuration", "nullable": true, "example": "Configuration Clone" } }, "additionalProperties": false, "description": "Configuration Clone response data" }, "AllocationConfigurationCloneRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationConfigurationCloneRequestDto" } }, "additionalProperties": false }, "AllocationConfigurationClonedResponseDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "Id of cloned configuration", "format": "uuid", "example": "c18a8634-b259-46fc-90c2-19ff2b24d85e" } }, "additionalProperties": false, "description": "Configuration Clone response data" }, "AllocationConfigurationClonedResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationConfigurationClonedResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationConfigurationVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Capacity to Service Configuration Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "configurationId": { "type": "string", "description": "Capacity to Service Configuration Id", "format": "uuid", "example": "22bf9ef9-0535-4d9b-a61e-9945cdf508cb" }, "name": { "type": "string", "description": "Capacity to Service Configuration's name", "nullable": true, "example": "Individuals Only" }, "periodType": { "type": "string", "description": "Type of Period", "nullable": true, "example": "Year" }, "numberOfPreviousPeriods": { "type": "integer", "description": "Number of previous periods", "format": "int32", "example": 4 }, "startDate": { "type": "string", "description": "Start date of period references", "format": "date-time", "example": "2022-10-10T00:00:00.000Z" }, "prefix": { "type": "string", "description": "Prefix you want to set before period references", "nullable": true, "example": "FY" }, "businessCategory": { "type": "string", "description": "Capacity to Service business category", "nullable": true, "example": "Basic Details" }, "validationData": { "$ref": "#/components/schemas/StandardValidationDataDto" }, "allocationValidationData": { "$ref": "#/components/schemas/AllocationValidationDataDto" }, "conditionOperators": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorDto" }, "description": "List of scoping conditions", "nullable": true }, "versionNumber": { "type": "integer", "description": "Version Number", "format": "int32", "example": 2 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees/approvals of the version", "nullable": true }, "totalRowDataGroupId": { "type": "string", "description": "The Id of the data group used to derive a CTS total row initial figure", "nullable": true, "deprecated": true }, "totalRowFinancialItem": { "type": "string", "description": "The name of the financial item used to derive a CTS total row initial figure", "nullable": true, "deprecated": true }, "financialAnalysisType": { "type": "string", "description": "The financial analysis type that the Allocations are applicable to", "nullable": true, "example": "Scenario" }, "allocationContext": { "type": "array", "items": { "type": "string" }, "description": "Entity types that the configuration is applicable to", "nullable": true, "example": [ "Company", "Deal", "Joint" ] }, "allocationEntityTypeConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationEntityTypeConfigurationDto" }, "description": "It holds the configuration of the entity types", "nullable": true } }, "additionalProperties": false, "description": "Set of properties which define new version of Capacity to Service Configuration" }, "AllocationConfigurationVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationConfigurationVersionDto" } }, "additionalProperties": false }, "AllocationConfigurationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationConfigurationVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationConfigurationVersionSignedResponseDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "The Id of the configuration the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version number that has been signed", "format": "int32" }, "status": { "$ref": "#/components/schemas/VersionStatus" } }, "additionalProperties": false, "description": "Contains the new version Status, after a version sign operation" }, "AllocationConfigurationVersionSignedResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationConfigurationVersionSignedResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationEntityTypeConfigurationDataDto": { "type": "object", "properties": { "entityType": { "type": "string", "description": "Entity Type of the configuration.", "nullable": true }, "surplusDeficitDataGroupId": { "type": "string", "description": "The Id of the data group used to derive a CTS total row initial figure.", "nullable": true }, "surplusDeficitFinancialItem": { "type": "string", "description": "The name of the financial item used to derive a CTS total row initial figure.", "nullable": true }, "identifiersDataGroupId": { "type": "string", "description": "The Id of the data group which will be use to identify statements.", "nullable": true }, "identifiersFinancialItem": { "type": "array", "items": { "type": "string" }, "description": "The financial items which will match with other entities.", "nullable": true }, "detailsDataGroupId": { "type": "string", "description": "The Id of the data group used to show financial details.", "nullable": true }, "detailsFinancialItem": { "type": "array", "items": { "type": "string" }, "description": "The names of the financial items used to show financial details.", "nullable": true } }, "additionalProperties": false }, "AllocationEntityTypeConfigurationDto": { "type": "object", "properties": { "entityType": { "type": "string", "description": "Entity Type of the configuration.", "nullable": true, "example": "Individual" }, "surplusDeficitDataGroupId": { "type": "string", "description": "The Id of the data group used to derive a CTS total row initial figure.", "nullable": true, "example": "123f8be3-f29b-4959-8964-956d4af7c468" }, "surplusDeficitFinancialItem": { "type": "string", "description": "The name of the financial item used to derive a CTS total row initial figure.", "nullable": true, "example": "EBITDA" }, "identifiersDataGroupId": { "type": "string", "description": "The Id of the data group which will be use to identify statements.", "nullable": true, "example": "123f8be3-f29b-4959-8964-956d4af7c468" }, "identifiersFinancialItem": { "type": "array", "items": { "type": "string" }, "description": "The financial items which will match with other entities.", "nullable": true, "example": [ "StatementDate", "Periods" ] }, "detailsDataGroupId": { "type": "string", "description": "The Id of the data group used to show financial details.", "nullable": true, "example": "123f8be3-f29b-4959-8964-956d4af7c468" }, "detailsFinancialItem": { "type": "array", "items": { "type": "string" }, "description": "The names of the financial items used to show financial details.", "nullable": true, "example": [ "Revenue", "EBITDA" ] } }, "additionalProperties": false }, "AllocationGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Allocation Group Id", "format": "uuid", "example": "45a0ed7a-aad9-4252-951c-b62020e8ef54" }, "name": { "type": "string", "description": "Allocation Group Name", "nullable": true, "example": "KFC Engadine" }, "type": { "type": "string", "description": "Association Type", "nullable": true, "example": "Shareholder" }, "allocationItems": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationItemDto" }, "description": "List of Allocation Items", "nullable": true }, "calculationSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationSummaryDto" }, "description": "List of calculation of summary periods value", "nullable": true }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodDto" }, "description": "List of periods captured in this Allocation Group", "nullable": true }, "financialAnalysisRecords": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAnalysisRecordDto" }, "description": "Financial Analysis data to derive initial values for CTS total row per entry", "nullable": true } }, "additionalProperties": false, "description": "Financial Group" }, "AllocationGroupSchema": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of Allocation Group Schema", "format": "uuid", "nullable": true, "example": "a36f544d-37af-4370-9438-460482ef09e1" }, "name": { "type": "string", "description": "Allocation Group Schema Name", "nullable": true, "example": "Parent Entity (Condition Name)" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "periodSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodSchema" }, "description": "Period schemas that contain periods information", "nullable": true }, "validationData": { "$ref": "#/components/schemas/StandardValidationDataDto" }, "allocationValidationData": { "$ref": "#/components/schemas/AllocationValidationDataDto" }, "businessCategory": { "type": "string", "description": "Capacity to Service business category", "nullable": true }, "totalRowDataGroupId": { "type": "string", "description": "The Id of the data group used to derive a CTS total row initial figure", "nullable": true }, "totalRowFinancialItem": { "type": "string", "description": "The name of the financial item used to derive a CTS total row initial figure", "nullable": true }, "financialAnalysisType": { "type": "string", "description": "The financial analysis type that the Allocations are applicable to", "nullable": true }, "allocationContext": { "type": "array", "items": { "type": "string" }, "description": "Entity types that the configuration is applicable to", "nullable": true }, "allocationEntityTypeConfigurations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationEntityTypeConfigurationDataDto" }, "description": "It holds the configuration of the entity types", "nullable": true } }, "additionalProperties": false, "description": "Model that contains fields related to financial analysis and are mapped from policy requirement dto" }, "AllocationItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Allocation Item GUiD", "format": "uuid", "example": "88009731-77df-4e72-98e7-0d314b7a5151" }, "sourceEntityId": { "type": "string", "description": "Source Entity Id", "nullable": true, "example": "2db6a893-8e1c-4b0c-b1f9-4b84d86fcf45" }, "sourceEntityType": { "type": "string", "description": "Source Entity Type", "nullable": true, "example": "Individual" }, "sourceEntityList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "Source Entity List", "nullable": true }, "relatedPartyId": { "type": "string", "description": "Related Party Id", "nullable": true, "example": "960cf8e0-d238-4969-934f-596f7f1c5b66" }, "relatedPartyType": { "type": "string", "description": "Related Party Type", "nullable": true, "example": "Individual" }, "relatedPartyList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "Related Party List", "nullable": true }, "allocationType": { "type": "string", "description": "Allocation Type", "nullable": true, "example": "addfrom" }, "periodReferences": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodReferenceDto" }, "description": "Value of the Allocation Item per period", "nullable": true } }, "additionalProperties": false, "description": "Financial Item" }, "AllocationSchemaDto": { "type": "object", "properties": { "allocationGroupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationGroupSchema" }, "description": "Allocation schemas that contain allocations grid information", "nullable": true } }, "additionalProperties": false, "description": "Model that contains information to build capacity to service schema" }, "AllocationSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationSchemaDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationSchemaRequestDto": { "type": "object", "properties": { "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Individual" }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties used for condition evaluation", "nullable": true } }, "additionalProperties": false }, "AllocationSchemaRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationSchemaRequestDto" } }, "additionalProperties": false }, "AllocationSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Capacity to Service Set GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id which Capacity to Service belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which Capacity to Service belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "status": { "type": "string", "description": "Capacity to Service Set Status", "nullable": true, "example": "Draft" } }, "additionalProperties": false, "description": "Capacity to Service Set representation" }, "AllocationSetDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationSetDto" } }, "additionalProperties": false }, "AllocationSetDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationSetDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationValidationDataDto": { "type": "object", "properties": { "onlyIndividualsCanAllocate": { "$ref": "#/components/schemas/BasicRuleDto" }, "totalAllocationLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" } }, "additionalProperties": false, "description": "Request DTO representing business validation data metadata" }, "AllocationVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Capacity to Service Version GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "setId": { "type": "string", "description": "Capacity to Service Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "description": { "type": "string", "description": "Capacity to Service description", "nullable": true, "example": "Home loan application" }, "status": { "type": "string", "description": "Capacity to Service Status", "nullable": true, "example": "Draft" }, "allocationGroups": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationGroupDto" }, "description": "List of Allocations Added from/Lessened to Legal Entity", "nullable": true }, "lastUpdatedDateTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "isAllocationsDisabledByUser": { "type": "boolean", "description": "Indicates whether the Allocations Grid is disabled by user in UI" } }, "additionalProperties": false, "description": "Capacity to Service Version representation" }, "AllocationVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationVersionDto" } }, "additionalProperties": false }, "AllocationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AllocationVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "$ref": "#/components/schemas/Decision" }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ApproveActionServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ApproveAction" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "$ref": "#/components/schemas/Approver" }, "action": { "$ref": "#/components/schemas/ApproveAction" }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "BasicRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "BasicRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" } }, "additionalProperties": false, "description": "Request DTO representing basic validation rule metadata" }, "BasicRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "nullable": true, "example": true }, "staticRule": { "$ref": "#/components/schemas/BasicRuleDto2" } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "CalculationSummaryDto": { "type": "object", "properties": { "periodName": { "type": "string", "description": "Calculated period id", "nullable": true }, "value": { "type": "string", "description": "Calculated value", "nullable": true } }, "additionalProperties": false, "description": "Summary of a financial group by period" }, "CollectionMaximumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMaxCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with maximum count", "nullable": true, "example": { "Registered": 1 } }, "overallMaximumCount": { "type": "integer", "description": "Overall maximum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection maximum count validation rule metadata" }, "CollectionMaximumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "nullable": true, "example": true }, "staticRule": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "CollectionMinimumCountRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minumim count validation rule metadata" }, "CollectionMinimumCountRuleDto2": { "type": "object", "properties": { "errorMessage": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "requiredTypesMinCount": { "type": "object", "additionalProperties": { "type": "integer", "format": "int32" }, "description": "Dictionary of required Primary Data Group Field values with minimum count", "nullable": true, "example": { "Registered": 1 } }, "overallMinimumCount": { "type": "integer", "description": "Overall minimum count", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing collection minimum count validation rule metadata" }, "CollectionMinimumCountRuleDtoValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "nullable": true, "example": true }, "staticRule": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "ColumnSummaryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the column", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Summary of a financial group by column" }, "CommentaryGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Commentary Group Id", "format": "uuid", "example": "c031699e-f5a2-4382-a4f6-9f2b3cd3ed4d" }, "name": { "type": "string", "description": "Commentary Group Name", "nullable": true, "example": "Commentary" }, "type": { "type": "string", "description": "Commentary Group Type", "nullable": true, "example": "commentary" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "description": "Commentary Fields", "nullable": true } }, "additionalProperties": false }, "ConditionOperatorDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id", "format": "uuid", "example": "38c8bc5c-364a-4213-a1e9-7fc5541de823" }, "logicalOperator": { "type": "string", "description": "Logical operator", "nullable": true, "example": "And" }, "conditionName": { "type": "string", "description": "Condition Name", "nullable": true, "example": "APAC Agricultural Company" }, "conditionDescription": { "type": "string", "description": "Condition Description", "nullable": true, "example": "Entity type and company requirements" }, "conditionOperatorItems": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorItemDto" }, "description": "Condition Operator Items", "nullable": true } }, "additionalProperties": false, "description": "Set of properties which define a Scoping Condition Operator" }, "ConditionOperatorItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id", "format": "uuid", "example": "8be001f1-2120-49ff-b4ca-87cb279ae7b7" }, "dataSource": { "type": "string", "description": "Source of Datakey: currentEntity", "nullable": true, "example": "currentEntity" }, "dataKey": { "type": "string", "description": "Datakey", "nullable": true, "example": "entityType" }, "logicalOperator": { "type": "string", "description": "Logical Operator includes: Equals, NotEquals, In, NotIn, Defined, NotDefined", "nullable": true, "example": "Equals" }, "value": { "type": "array", "items": { "type": "string" }, "description": "Assigned Value", "nullable": true, "example": [ "Company" ] }, "valueType": { "type": "string", "description": "Value Type: text, select, multiselect, number, date", "nullable": true, "example": "text" } }, "additionalProperties": false, "description": "Set of properties which define a Condition Operator Item" }, "ConfigurationCloneRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of cloned configuration", "nullable": true, "example": "Configuration Clone" } }, "additionalProperties": false, "description": "Configuration Clone response data" }, "ConfigurationCloneRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationCloneRequestDto" } }, "additionalProperties": false }, "ConfigurationClonedResponseDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "Id of cloned configuration", "format": "uuid", "example": "c18a8634-b259-46fc-90c2-19ff2b24d85e" } }, "additionalProperties": false, "description": "Configuration Clone response data" }, "ConfigurationClonedResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationClonedResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis Configuration Id", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "versionNumber": { "type": "integer", "description": "Version Number", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "Financial Configuration's name", "nullable": true, "example": "Version 1" }, "periodType": { "type": "string", "description": "Type of Period", "nullable": true, "example": "Year" }, "numberOfPreviousPeriods": { "type": "integer", "description": "Number of previous periods", "format": "int32", "example": 5 }, "startDate": { "type": "string", "description": "Start date of period references", "format": "date-time", "example": "2022-10-10T00:00:00.000Z" }, "prefix": { "type": "string", "description": "Prefix you want to set before period references", "nullable": true, "example": "FY" }, "dataGroups": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupDto" }, "description": "List of data groups", "nullable": true }, "conditionOperators": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorDto" }, "description": "List of scoping conditions", "nullable": true }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2022-10-10T00:00:00.000Z" }, "created": { "type": "string", "description": "The creation date of the version (Read-only) Configuration", "format": "date-time" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees/approvals of the version", "nullable": true }, "financialAnalysisType": { "type": "string", "description": "Determines the configuration is for Actual or Scenario", "nullable": true }, "minimumColumns": { "type": "integer", "description": "Minimum number of period columns. This will be applied only for Scenario.", "format": "int32", "nullable": true }, "maximumColumns": { "type": "integer", "description": "Maximum number of period columns. This will be applied only for Scenario.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Financial Group Configuration Representation" }, "ConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationDto" } }, "additionalProperties": false }, "ConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConfigurationVersionDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "Financial Analysis Configuration Id", "format": "uuid", "example": "22bf9ef9-0535-4d9b-a61e-9945cdf508cb" }, "name": { "type": "string", "description": "Financial Configuration's name", "nullable": true, "example": "F1" }, "periodType": { "type": "string", "description": "Type of Period", "nullable": true, "example": "Year" }, "numberOfPreviousPeriods": { "type": "integer", "description": "Number of previous periods", "format": "int32", "example": 5 }, "startDate": { "type": "string", "description": "Start date of period references", "format": "date-time", "example": "2022-10-10T00:00:00.000Z" }, "prefix": { "type": "string", "description": "Prefix you want to set before period references", "nullable": true, "example": "FY" }, "dataGroups": { "type": "array", "items": { "$ref": "#/components/schemas/DataGroupDto" }, "description": "List of data groups", "nullable": true }, "conditionOperators": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorDto" }, "description": "List of scoping conditions", "nullable": true }, "versionNumber": { "type": "integer", "description": "Version Number", "format": "int32", "example": 2 }, "effectiveFrom": { "type": "string", "description": "The date that the version takes effect when published", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/Signee" }, "description": "The defined list of signees/approvals of the version", "nullable": true }, "financialAnalysisType": { "type": "string", "description": "Determines the configuration is for Actual or Scenario", "nullable": true }, "minimumColumns": { "type": "integer", "description": "Minimum number of period columns. This will be applied only for Scenario.", "format": "int32", "nullable": true }, "maximumColumns": { "type": "integer", "description": "Maximum number of period columns. This will be applied only for Scenario.", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Set of properties which define new version of Financial Group Configuration" }, "ConfigurationVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationVersionDto" } }, "additionalProperties": false }, "ConfigurationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConfigurationVersionSignedResponseDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "The Id of the configuration the version belongs to", "format": "uuid" }, "versionNumber": { "type": "integer", "description": "The version number that has been signed", "format": "int32" }, "status": { "$ref": "#/components/schemas/VersionStatus" } }, "additionalProperties": false, "description": "Contains the new version Status, after a version sign operation" }, "ConfigurationVersionSignedResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ConfigurationVersionSignedResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateImportDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id linked to the import", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id linked to the import", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id linked to the import", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "importParameters": { "description": "Parameters that is used to issue import request", "nullable": true } }, "additionalProperties": false }, "CreateImportDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateImportDto" } }, "additionalProperties": false }, "CreateImportResponseDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id linked to the import", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "journeyId": { "type": "string", "description": "Journey Id linked to the import", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id linked to the import", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "importParameters": { "description": "Parameters that is used to issue import request", "nullable": true }, "id": { "type": "string", "description": "Import GUID", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "providerId": { "type": "string", "description": "Provider Id of the Import", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "status": { "type": "string", "description": "Import status", "nullable": true, "example": "In Progress" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDto" }, "description": "List of objects contain error information", "nullable": true } }, "additionalProperties": false }, "CreateImportResponseDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreateImportResponseDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "CreateImportResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateImportResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "DataFieldDto": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Property name", "nullable": true, "example": "firstName" }, "propertyType": { "type": "string", "description": "Property type", "nullable": true, "example": "text" }, "propertyTypeId": { "type": "string", "description": "Property type id", "format": "uuid", "nullable": true, "example": "ab92ecbc-bd77-494b-acad-3d2fb0b8136c" } }, "additionalProperties": false, "description": "Request DTO representing data field metadata" }, "DataGroupDto": { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "Data group Id", "format": "uuid", "example": "c92b1280-8457-4082-ae8b-4c9e6678a49d" }, "versionNumber": { "type": "integer", "description": "Version of the data group", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Set of properties which define a data group" }, "DataValidationRulesDto": { "type": "object", "properties": { "mandatory": { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" }, "collectionMinimumCount": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" }, "collectionMaximumCount": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" }, "readOnly": { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } }, "additionalProperties": false, "description": "Request DTO representing validation rule metadata" }, "Decision": { "enum": [ "Approve", "Reject" ], "type": "string" }, "EmptyRuleDto": { "type": "object", "additionalProperties": false }, "EmptyRuleDtoConditionalValidationRuleDto": { "type": "object", "properties": { "isActive": { "type": "boolean", "description": "Validation rule active flag", "nullable": true, "example": true }, "staticRule": { "$ref": "#/components/schemas/EmptyRuleDto" } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "ErrorDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message", "nullable": true } }, "additionalProperties": false }, "ExternalReviewStatusDto": { "type": "object", "properties": { "status": { "type": "string", "description": "Financial Analysis Version External Review Status", "nullable": true, "example": "Pending, Approved" } }, "additionalProperties": false }, "ExternalReviewStatusDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExternalReviewStatusDto" } }, "additionalProperties": false }, "ExternalReviewStatusDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ExternalReviewStatusDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FieldDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "Address" }, "friendlyName": { "type": "string", "description": "Friendly name of the field\nFor display purpose", "nullable": true, "example": "" }, "isMandatory": { "type": "boolean", "description": "The flag to set if property is mandatory", "nullable": true }, "type": { "type": "string", "description": "Type of the field", "nullable": true, "example": "String" }, "description": { "type": "string", "description": "Description of the field", "nullable": true, "example": "Address line 1" }, "nestedFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "Nested field", "nullable": true } }, "additionalProperties": false, "description": "The Field schema" }, "FinancialAnalysisConfiguration": { "type": "object", "properties": { "minimumColumns": { "type": "integer", "description": "Minimum number of period columns, used for group validation", "format": "int32", "nullable": true }, "maximumColumns": { "type": "integer", "description": "Maximum number of period columns, used for group validation", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Model that contains information from Financial Analysis Configuration for the schema to use, mainly for validation" }, "FinancialAnalysisRecordDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id", "nullable": true }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "List of entities that joint financial analysis set belongs to", "nullable": true }, "financialAnalysisSetId": { "type": "string", "description": "Financial Analysis Set Id that the Financial Item Data belongs to", "nullable": true }, "financialAnalysisVersionId": { "type": "string", "description": "Financial Analysis Version Id that the Financial Item Data belongs to", "nullable": true }, "financialGroupId": { "type": "string", "description": "Financial Group Id that the Financial Item Data belongs to", "nullable": true }, "financialItemId": { "type": "string", "description": "Financial Group Item Id", "nullable": true }, "periodReferences": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodReferenceDto" }, "description": "Period references for the target financial item", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Data to be used to derive the values for the total row of Allocation Group" }, "FinancialAnalysisSchemaDto": { "type": "object", "properties": { "financialGroupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialGroupSchema" }, "description": "Financial group schemas that contain data groups information", "nullable": true }, "financialCommentarySchemas": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialGroupSchema" }, "description": "Schemas that contain commentary information", "nullable": true }, "lookupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSchema" }, "description": "Lookup schemas that contain data groups and associated lookups information", "nullable": true }, "scenarioSchema": { "$ref": "#/components/schemas/ScenarioSchema" }, "summarySchema": { "$ref": "#/components/schemas/SummarySchema" } }, "additionalProperties": false, "description": "Model that contains information to build financial analysis schema" }, "FinancialAnalysisSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialAnalysisSchemaDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialAnalysisSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis Set GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "entityId": { "type": "string", "description": "Entity Id which financial analysis Set belongs", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "entityType": { "type": "string", "description": "Financial Analysis Entity Type", "nullable": true, "example": "Company" }, "journeyId": { "type": "string", "description": "Journey Id which financial analysis belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which financial analysis belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "status": { "type": "string", "description": "Financial Analysis Set Status", "nullable": true, "example": "Draft" }, "isExternalReviewRequired": { "type": "boolean", "description": "Is External Review Required for Financial Analysis Set", "example": false } }, "additionalProperties": false, "description": "Financial Analysis Set representation" }, "FinancialAnalysisSetDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialAnalysisSetDto" } }, "additionalProperties": false }, "FinancialAnalysisSetDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialAnalysisSetDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialAnalysisVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis Version GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "setId": { "type": "string", "description": "Financial Analysis Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "description": { "type": "string", "description": "Financial Analysis description", "nullable": true, "example": "Home loan application" }, "status": { "type": "string", "description": "Financial Analysis Status", "nullable": true, "example": "Draft" }, "financialGroups": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialGroupDto" }, "description": "List of financial groups which defines the financial analysis", "nullable": true }, "financialCommentaries": { "type": "array", "items": { "$ref": "#/components/schemas/CommentaryGroupDto" }, "description": "List of commentary groups which contains the commentary fields", "nullable": true }, "lastUpdatedDateTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "externalReviewStatus": { "type": "string", "description": "External Review Status for this Version", "nullable": true, "example": "Pending" } }, "additionalProperties": false, "description": "Financial Analysis Version representation" }, "FinancialAnalysisVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialAnalysisVersionDto" } }, "additionalProperties": false }, "FinancialAnalysisVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FinancialAnalysisVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Group Id", "format": "uuid", "example": "51209731-77df-4e72-98e7-0d314b7a5151" }, "name": { "type": "string", "description": "Financial Group Name", "nullable": true, "example": "Personal Income" }, "type": { "type": "string", "description": "Financial Group Type", "nullable": true, "example": "Income" }, "financialItems": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialItemDto" }, "description": "List of Financial Items", "nullable": true }, "calculationSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationSummaryDto" }, "description": "List of calculation of summary periods value", "nullable": true }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodDto" }, "description": "List of periods captured in this Financial Group", "nullable": true } }, "additionalProperties": false, "description": "Financial Group" }, "FinancialGroupSchema": { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "The UiD of the root data group", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupVersion": { "type": "integer", "description": "Data group version number", "format": "int32", "nullable": true, "example": 1 }, "primaryDatakey": { "type": "string", "description": "Data group Primary datakey which is used by the dropdown", "nullable": true, "example": "assetType" }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "name": { "type": "string", "description": "Group name", "nullable": true, "example": "Income" }, "dataField": { "$ref": "#/components/schemas/DataFieldDto" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "$ref": "#/components/schemas/ValidationRuleDto" }, "validationRulesV2": { "$ref": "#/components/schemas/DataValidationRulesDto" }, "periodSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodSchema" }, "description": "Period schemas that contain periods information", "nullable": true } }, "additionalProperties": false, "description": "Model that contains fields related to financial analysis and are mapped from policy requirement dto" }, "FinancialItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Item GUiD", "format": "uuid", "example": "88009731-77df-4e72-98e7-0d314b7a5151" }, "dataKey": { "type": "string", "description": "Financial Item DataKey", "nullable": true, "example": "IncomeType" }, "value": { "type": "string", "description": "Financial Item Value", "nullable": true, "example": "Salary" }, "providerId": { "type": "string", "description": "Guid of import provider", "format": "uuid", "nullable": true, "example": "88009731-77df-4e72-98e7-0d314b7a5151" }, "source": { "type": "string", "description": "Source of the model", "nullable": true, "example": "Manual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "description": "Properties of a Financial Item", "nullable": true }, "periodReferences": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodReferenceDto" }, "description": "Value of the Financial Item per period", "nullable": true } }, "additionalProperties": false, "description": "Financial Item" }, "ImportMappingDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of the mapping, the value will be ignored when creating or updating the model", "format": "uuid" }, "providerId": { "type": "string", "description": "Provider Id for the import mapping", "format": "uuid" }, "importRequestDto": { "$ref": "#/components/schemas/MappingDto" }, "importResultDto": { "$ref": "#/components/schemas/MappingDto" } }, "additionalProperties": false, "description": "Import Mapping Dto Schema" }, "ImportMappingDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportMappingDto" } }, "additionalProperties": false }, "ImportMappingDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportMappingDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportProviderDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "enabled": { "type": "boolean", "nullable": true }, "providerConfigurationDto": { "$ref": "#/components/schemas/ProviderConfigurationDto" } }, "additionalProperties": false }, "ImportProviderDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportProviderDto" } }, "additionalProperties": false }, "ImportProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ImportProviderDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "JointEntityDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "Entity Id which financial analysis Set belongs", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "entityType": { "type": "string", "description": "Entity Type", "nullable": true, "example": "Company" } }, "additionalProperties": false, "description": "Entity of Financial Analysis" }, "JointFinancialAnalysisInitializeRequestDto": { "type": "object", "properties": { "journeyId": { "type": "string", "description": "Journey Id which joint financial analysis belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which joint financial analysis belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "List of entities that joint financial analysis set belongs to", "nullable": true }, "retrieveSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/RetrieveSchemaDto" }, "description": "List of requests for retrieving FA schemas", "nullable": true }, "isExternalReviewRequired": { "type": "boolean", "description": "Is External Review Required" } }, "additionalProperties": false, "description": "Request for initializing joint Financial Analysis representation" }, "JointFinancialAnalysisInitializeRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JointFinancialAnalysisInitializeRequestDto" } }, "additionalProperties": false }, "JointFinancialAnalysisInitializeResponseDto": { "type": "object", "properties": { "financialAnalysisSet": { "$ref": "#/components/schemas/JointFinancialAnalysisSetDto" }, "financialAnalysisVersion": { "$ref": "#/components/schemas/FinancialAnalysisVersionDto" }, "financialAnalysisSchema": { "$ref": "#/components/schemas/FinancialAnalysisSchemaDto" } }, "additionalProperties": false, "description": "Response for initializing joint Financial Analysis representation" }, "JointFinancialAnalysisInitializeResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JointFinancialAnalysisInitializeResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "JointFinancialAnalysisSetDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Joint Financial Analysis Set GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "Entities which joint financial analysis set belongs", "nullable": true }, "entityType": { "type": "string", "description": "Joint Financial Analysis Entity Type", "nullable": true, "example": "Company" }, "journeyId": { "type": "string", "description": "Journey Id which joint financial analysis belongs", "format": "uuid", "example": "950c8f8f-a367-4f0e-a6ea-23cc3c104cc4" }, "taskId": { "type": "string", "description": "Task Id which joint financial analysis belongs", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "status": { "type": "string", "description": "Joint Financial Analysis Set Status", "nullable": true, "example": "Draft" } }, "additionalProperties": false, "description": "Joint Financial Analysis Set representation" }, "LookupSchema": { "type": "object", "properties": { "lookupId": { "type": "string", "description": "Lookup id of the Primary DataKey", "format": "uuid", "example": "30475116-518b-4c8d-b7ae-e5453104682a" }, "lookupVersion": { "type": "integer", "description": "Lookup version number", "format": "int32", "nullable": true }, "linkLookupId": { "type": "string", "description": "Link lookup id of the Primary DataKey", "format": "uuid", "nullable": true, "example": "30475116-518b-4c8d-b7ae-e5453104682a" }, "linkLookupVersion": { "type": "integer", "description": "Link lookup version number", "format": "int32", "nullable": true }, "validationDataGroupId": { "type": "string", "description": "Validations Data group id", "nullable": true }, "validationDataGroupVersion": { "type": "integer", "description": "Validations Data group version number", "format": "int32", "nullable": true }, "dataGroupDataKey": { "type": "string", "description": "Data key of the data group", "nullable": true, "example": "asset" }, "primaryDatakey": { "type": "string", "description": "Primary field data key of the data group", "nullable": true, "example": "country" } }, "additionalProperties": false, "description": "Model that contains information to build lookup schema" }, "MappingDto": { "type": "object", "properties": { "ruleSets": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleSetDto" }, "description": "The list that contains all the mapping rules for a provider\nIt can be for request or result import mapping", "nullable": true } }, "additionalProperties": false, "description": "The schema for import mapping request and result" }, "MappingRuleDto": { "type": "object", "properties": { "order": { "type": "integer", "description": "This order will be used to generate mapping Path", "format": "int32" }, "propertyName": { "type": "string", "description": "Property Name", "nullable": true }, "isArrayProperty": { "type": "boolean", "description": "Flag if the property is array type and execute specific mapping logic", "nullable": true }, "includingNestedPath": { "type": "boolean", "description": "If true, it will find all properties (including nested properties) with this Property Name", "nullable": true } }, "additionalProperties": false, "description": "The mapping rule schema" }, "MappingRuleSetDto": { "type": "object", "properties": { "mappingRules": { "type": "array", "items": { "$ref": "#/components/schemas/MappingRuleDto" }, "description": "The list that contains all of the mapping rules", "nullable": true }, "targetProperty": { "type": "string", "description": "The targetProperty for mapping destination", "nullable": true, "example": "address" }, "targetPropertyFriendlyName": { "type": "string", "description": "The targetProperty friendly name for display", "nullable": true, "example": "address" }, "nestedMappingRules": { "$ref": "#/components/schemas/MappingDto" }, "targetPropertyType": { "type": "string", "description": "The type of the targetProperty", "nullable": true, "example": "String" } }, "additionalProperties": false, "description": "The schema that contains info of designated property" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "PeriodDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Unique name of a period", "nullable": true, "example": "FY2022" }, "startDate": { "type": "string", "description": "Period Starting Date Time", "format": "date-time", "example": "2020-01-01T00:00:00" }, "endDate": { "type": "string", "description": "Period End Date Time", "format": "date-time", "example": "2021-12-31T23:59:59" } }, "additionalProperties": false, "description": "Financial Analysis Period" }, "PeriodReferenceDto": { "type": "object", "properties": { "periodName": { "type": "string", "description": "Period unique name", "nullable": true, "example": "FY2022" }, "value": { "type": "string", "description": "Financial Item Value", "nullable": true, "example": "15500" } }, "additionalProperties": false, "description": "Value of a financial item for a specific period" }, "PeriodSchema": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "Financial period configuration Id", "nullable": true, "example": "30475116-518b-4c8d-b7ae-e5453104682a" }, "configurationVersion": { "type": "integer", "description": "Financial period configuration version number", "format": "int32", "nullable": true }, "orderFromCurrentPeriod": { "type": "integer", "description": "Year difference from current period, 0 represents current period", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "Name of the period", "nullable": true, "example": "FY2022" }, "startDate": { "type": "string", "description": "Start time of the period", "format": "date-time" }, "endDate": { "type": "string", "description": "End time of the period", "format": "date-time" }, "readOnly": { "type": "boolean", "description": "Indicates whether the period column is read-only or not" } }, "additionalProperties": false, "description": "Model that contains information to build period schema" }, "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": { } }, "PropertyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PropertyType" }, "discriminator": { "$ref": "#/components/schemas/PropertyType" }, "isValid": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ProviderConfigurationDto": { "type": "object", "properties": { "providerDetailsDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderDetailsDto" }, "nullable": true }, "adapterConfigurationDto": { "$ref": "#/components/schemas/AdapterConfigurationDto" }, "securityKeysDto": { "$ref": "#/components/schemas/SecurityKeysDto" } }, "additionalProperties": false }, "ProviderDetailsDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "maskRequired": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "ProviderEnabledRequestDto": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "States if a provider is enabled.", "nullable": true, "example": true } }, "additionalProperties": false, "description": "Import Provider enabled request Schema" }, "ProviderEnabledRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProviderEnabledRequestDto" } }, "additionalProperties": false }, "RetrieveSchemaDto": { "type": "object", "properties": { "entityType": { "type": "string", "description": "Type of entity", "nullable": true, "example": "Individual" }, "targetEntity": { "type": "string", "description": "Target entity", "nullable": true, "example": "Client" }, "jurisdictions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionedJurisdictionDto" }, "description": "Jurisdictions of the requirement in specific version. Null versionId will get the latest.", "nullable": true }, "categories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement for actual category e.g. [\"Basic Details\", \"Enrich Details\"]", "nullable": true }, "scenarioCategories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement for scenario category e.g. [\"Scenario\"]", "nullable": true }, "summaryCategories": { "type": "array", "items": { "type": "string" }, "description": "List of requirement for summary category e.g. [\"Summary\"]", "nullable": true }, "entityDataProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Entity data properties used for condition evaluation", "nullable": true }, "dealProperties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyDto" }, "description": "Deal properties used for condition evaluation", "nullable": true }, "requirementSetId": { "type": "string", "description": "Deal Requirement Set", "nullable": true }, "requirementVersion": { "type": "integer", "description": "Deal Requirement version number", "format": "int32" }, "isCurrentEntityPartOfJoint": { "type": "boolean", "description": "Is Current Entity Part Of Joint" } }, "additionalProperties": false }, "RetrieveSchemaDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RetrieveSchemaDto" } }, "additionalProperties": false }, "ScenarioColumnDefinitionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of scenario", "format": "uuid", "example": "3cea3da2-c268-466b-b2bd-4a0d8f08576a" }, "name": { "type": "string", "description": "Name of scenario", "nullable": true, "example": "Scenario 1" }, "groupId": { "type": "string", "description": "Unique Group Id of the column", "nullable": true, "example": "Scenario 1" }, "readOnly": { "type": "boolean", "description": "Read Only Column", "example": false }, "order": { "type": "integer", "description": "Order of the column", "format": "int32", "example": 1 }, "source": { "type": "string", "description": "Source of the column", "nullable": true, "example": "Manual" }, "providerId": { "type": "string", "description": "Financial Import Provider Id if column is imported from provider", "format": "uuid", "nullable": true, "example": "1cea3d12-c268-466b-b2bd-4a0d8f08576a" } }, "additionalProperties": false, "description": "Financial Analysis Period" }, "ScenarioGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Scenario Group Id", "format": "uuid", "example": "51209731-77df-4e72-98e7-0d314b7a5151" }, "name": { "type": "string", "description": "Scenario Group Name", "nullable": true, "example": "Natural Disaster" }, "type": { "type": "string", "description": "Scenario Group Type", "nullable": true, "example": "Manual" }, "scenarioItems": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioItemDto" }, "description": "List of Scenario Items", "nullable": true }, "scenarioColumnDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioColumnDefinitionDto" }, "description": "List of scenarios captured in this Scenario Group", "nullable": true }, "calculationSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/CalculationSummaryDto" }, "description": "List of calculation of summary per column", "nullable": true } }, "additionalProperties": false }, "ScenarioGroupSchema": { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "The UiD of the root data group", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupVersion": { "type": "integer", "description": "Data group version number", "format": "int32", "nullable": true, "example": 1 }, "primaryDatakey": { "type": "string", "description": "Data group Primary datakey which is used by the dropdown", "nullable": true, "example": "assetType" }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "name": { "type": "string", "description": "Group name", "nullable": true, "example": "Income" }, "dataField": { "$ref": "#/components/schemas/DataFieldDto" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "$ref": "#/components/schemas/ValidationRuleDto" }, "validationRulesV2": { "$ref": "#/components/schemas/DataValidationRulesDto" }, "financialAnalysisConfiguration": { "$ref": "#/components/schemas/FinancialAnalysisConfiguration" } }, "additionalProperties": false, "description": "Model that contains fields related to financial analysis scenario schema" }, "ScenarioItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Scenario Item GUiD", "format": "uuid", "example": "88009731-77df-4e72-98e7-0d314b7a5151" }, "foreignId": { "type": "string", "description": "Scenario Item Foreign Id if it is cloned from other item", "nullable": true, "example": "" }, "dataKey": { "type": "string", "description": "Scenario Item DataKey", "nullable": true, "example": "disasterType" }, "value": { "type": "string", "description": "Scenario Item Value", "nullable": true, "example": "Disaster Type" }, "source": { "type": "string", "description": "Source of the model", "nullable": true, "example": "Manual" }, "providerId": { "type": "string", "description": "Financial Import Provider Id", "format": "uuid", "nullable": true, "example": "" }, "providerItemId": { "type": "string", "description": "Import Item Id from the provider", "nullable": true, "example": "" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "description": "Properties of a Scenario Item", "nullable": true }, "scenarioValues": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioValueDto" }, "description": "Value of the Scenario Item per scenario", "nullable": true } }, "additionalProperties": false, "description": "Scenario Item" }, "ScenarioSchema": { "type": "object", "properties": { "scenarioGroupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioGroupSchema" }, "description": "Scenario schemas that contain scenario's data groups information", "nullable": true }, "scenarioCommentarySchemas": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioGroupSchema" }, "description": "Schemas that contain scenario's commentary information", "nullable": true }, "scenarioLookupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSchema" }, "description": "Lookup schemas that contain data groups and associated lookups information", "nullable": true } }, "additionalProperties": false }, "ScenarioValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of Column", "format": "uuid", "example": "3cea3da2-c268-466b-b2bd-4a0d8f08576a" }, "value": { "type": "string", "description": "Value", "nullable": true, "example": "Earthquake" } }, "additionalProperties": false, "description": "Value of a scenario item for a specific column" }, "ScenarioVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis Version GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "setId": { "type": "string", "description": "Financial Analysis Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "scenarioGroups": { "type": "array", "items": { "$ref": "#/components/schemas/ScenarioGroupDto" }, "description": "List of scenario groups which belong to the financial analysis version", "nullable": true }, "scenarioCommentaries": { "type": "array", "items": { "$ref": "#/components/schemas/CommentaryGroupDto" }, "description": "List of commentary groups which contains the commentary fields", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Scenario representation" }, "ScenarioVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ScenarioVersionDto" } }, "additionalProperties": false }, "ScenarioVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ScenarioVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "importRequest": { "$ref": "#/components/schemas/SchemaEntryDto" }, "importResult": { "$ref": "#/components/schemas/SchemaEntryDto" } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "nullable": true } }, "additionalProperties": false }, "SecurityKeysDto": { "type": "object", "properties": { "authenticationKey": { "type": "string", "nullable": true }, "encryptionKey": { "type": "string", "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": { "$ref": "#/components/schemas/Approver" }, "action": { "$ref": "#/components/schemas/ApproveAction" }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SinglePropertyDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/PropertyType" }, "discriminator": { "$ref": "#/components/schemas/PropertyType" }, "isValid": { "type": "boolean", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StandardValidationDataDto": { "type": "object", "properties": { "isMandatory": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyInteger": { "$ref": "#/components/schemas/BasicRuleDto" }, "noNegative": { "$ref": "#/components/schemas/BasicRuleDto" }, "onlyDecimal": { "$ref": "#/components/schemas/BasicRuleDto" }, "numberLimit": { "$ref": "#/components/schemas/ValueLimitRuleDto" } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "StatusDto": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of Financial Analysis Version", "nullable": true, "example": "Draft" } }, "additionalProperties": false }, "StatusDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatusDto" } }, "additionalProperties": false }, "StatusDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatusDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SummaryColumnDefinitionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Summary Column Identifier GUiD", "format": "uuid", "example": "3cea3da2-c268-466b-b2bd-4a0d8f08576a" }, "name": { "type": "string", "description": "Unique Summary column name", "nullable": true, "example": "FY2022" }, "type": { "type": "string", "description": "Column Type Actual, Scenario or Summary", "nullable": true, "example": "Summary" }, "originColumnId": { "type": "string", "description": "Origin Column Identifier from Actual or Scenario", "nullable": true, "example": "" } }, "additionalProperties": false }, "SummaryGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Summary Group Id", "format": "uuid", "example": "a01beaaa-a9fc-4d25-971b-b4add3c6050c" }, "actualGroupId": { "type": "string", "description": "Actual Group Id", "nullable": true, "example": "" }, "scenarioGroupId": { "type": "string", "description": "Scenario Group Id", "nullable": true, "example": "" }, "name": { "type": "string", "description": "Summary Group Name", "nullable": true, "example": "FA Income" }, "type": { "type": "string", "description": "Summary Group Type", "nullable": true, "example": "Income" }, "summaryItems": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryItemDto" }, "description": "List of Summary Items", "nullable": true }, "calculationSummaries": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnSummaryDto" }, "description": "List of calculation of summary periods value", "nullable": true }, "summaryColumnDefinitions": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryColumnDefinitionDto" }, "description": "List of periods captured in this Summary Group", "nullable": true } }, "additionalProperties": false }, "SummaryGroupSchema": { "type": "object", "properties": { "dataGroupId": { "type": "string", "description": "The UiD of the root data group", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "dataGroupVersion": { "type": "integer", "description": "Data group version number", "format": "int32", "nullable": true, "example": 1 }, "primaryDatakey": { "type": "string", "description": "Data group Primary datakey which is used by the dropdown", "nullable": true, "example": "assetType" }, "id": { "type": "string", "description": "The UiD of the requirement", "format": "uuid", "nullable": true, "example": "84ec28e2-d786-417b-850f-96321dd849dd" }, "name": { "type": "string", "description": "Group name", "nullable": true, "example": "Income" }, "dataField": { "$ref": "#/components/schemas/DataFieldDto" }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "$ref": "#/components/schemas/ValidationRuleDto" }, "validationRulesV2": { "$ref": "#/components/schemas/DataValidationRulesDto" } }, "additionalProperties": false, "description": "Model that contains fields related to financial analysis summary schema" }, "SummaryItemDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Summary Item GUiD", "format": "uuid", "example": "9cc44cb8-d783-4823-beca-da236e0c10b4" }, "actualItemId": { "type": "string", "description": "Referenced Actual Item Id", "nullable": true, "example": "" }, "scenarioItemId": { "type": "string", "description": "Referenced Scenario Item Id", "nullable": true, "example": "" }, "dataKey": { "type": "string", "description": "Summary Item DataKey", "nullable": true, "example": "incomeType" }, "value": { "type": "string", "description": "Summary Item Value", "nullable": true, "example": "Bonus" }, "source": { "type": "string", "description": "Source of the summary Item", "nullable": true, "example": "Manual" }, "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/SinglePropertyDto" }, "description": "Properties of a Summary Item", "nullable": true }, "summaryValues": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryValueDto" }, "description": "Value of the Summary Item per period", "nullable": true } }, "additionalProperties": false }, "SummarySchema": { "type": "object", "properties": { "summaryGroupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryGroupSchema" }, "description": "Summary schemas that contain summary's data groups information", "nullable": true }, "summaryCommentarySchemas": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryGroupSchema" }, "description": "Schemas that contain summary's commentary information", "nullable": true }, "summaryLookupSchemas": { "type": "array", "items": { "$ref": "#/components/schemas/LookupSchema" }, "description": "Lookup schemas that contain data groups and associated lookups information", "nullable": true } }, "additionalProperties": false }, "SummaryValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Id of Summary Column", "format": "uuid", "example": "3cea3da2-c268-466b-b2bd-4a0d8f08576a" }, "value": { "type": "string", "description": "Value", "nullable": true, "example": "2000" } }, "additionalProperties": false }, "SummaryVersionDto": { "type": "object", "properties": { "setId": { "type": "string", "description": "Financial Analysis Set GUiD", "format": "uuid", "example": "a4309731-77df-4e72-98e7-0d314b7a5151" }, "id": { "type": "string", "description": "Financial Analysis Version GUiD", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "summaryGroups": { "type": "array", "items": { "$ref": "#/components/schemas/SummaryGroupDto" }, "description": "List of summary groups which belong to the financial analysis version", "nullable": true }, "summaryCommentaries": { "type": "array", "items": { "$ref": "#/components/schemas/CommentaryGroupDto" }, "description": "List of commentary groups which contains the commentary fields", "nullable": true } }, "additionalProperties": false }, "SummaryVersionDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SummaryVersionDto" } }, "additionalProperties": false }, "SummaryVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SummaryVersionDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "$ref": "#/components/schemas/BasicRuleDto" }, "collectionMinimumCount": { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" }, "collectionMaximumCount": { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "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": { "id": { "type": "string", "description": "The UiD of the validation rule", "format": "uuid", "nullable": true, "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "setId": { "type": "string", "description": "The UiD of the requirement set/data group", "format": "uuid", "nullable": true, "example": "012cfe3a-7bfa-41e7-8269-d49b3b38dff3" }, "propertyId": { "type": "string", "description": "The UiD of the requirement/data group field", "format": "uuid", "nullable": true, "example": "450df9bf-b2d3-48cf-ab8d-481c69b74373" }, "propertyName": { "type": "string", "description": "Requirement/data group field property name", "nullable": true, "example": "firstName" }, "friendlyName": { "type": "string", "description": "Requirement/data group field friendly Name", "nullable": true, "example": "First Name" }, "validationType": { "type": "string", "description": "Validation type", "nullable": true, "example": "text" }, "validationData": { "$ref": "#/components/schemas/ValidationDataDto" } }, "additionalProperties": false, "description": "Request DTO representing validation rule metadata" }, "ValueLimitRuleDto": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Validation rule active flag", "example": true }, "message": { "type": "string", "description": "Validation rule error message", "nullable": true, "example": "Validation error occurred" }, "minValue": { "type": "integer", "description": "Minimum value", "format": "int32", "nullable": true, "example": 1 }, "maxValue": { "type": "integer", "description": "Maximum value", "format": "int32", "nullable": true, "example": 10 } }, "additionalProperties": false, "description": "Request DTO representing value limit rule metadata" }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" }, "VersionedJurisdictionDto": { "type": "object", "properties": { "jurisdiction": { "type": "string", "description": "Jurisdiction Name", "nullable": true, "example": "Global" }, "versionId": { "type": "string", "description": "Jurisdiction Version Id", "format": "uuid", "example": "254428e9-d232-4738-81c9-151409b296a3" } }, "additionalProperties": false, "description": "Defines the jurisdiction requirement for the financial analysis" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }