{ "openapi": "3.0.4", "info": { "title": "Fenergo Financial Analysis Query API", "description": "**Fenergo Financial Analysis Query API**:\n\n
Financial Analysis Query API provides methods to retrieve 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 Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/financialanalysisquery" } ], "paths": { "/api/allocation/set/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "Allocation" ], "summary": "Get Capacity to Service Set with latest Version by Journey, Task Id", "description": "\nThis method returns Capacity to Service Set with latest Version in the scope of journey, task

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetAllocationSetByJourneyTaskId", "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": { "200": { "description": "Success. Capacity to Service Set is returned", "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. Capacity to Service Set with given ids do 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/allocation/set/{setId}": { "get": { "tags": [ "Allocation" ], "summary": "Get a Capacity to Service Set of specified Id with all Version data", "description": "\nThis method returns the Capacity to Service Set of specified Id with all Capacity to Service Versions.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetAllocationSetById", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the Capacity to Service Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Capacity to Service Set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationVersionsLiteDtoServiceResponse" } } } }, "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. Capacity to Service Set 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/allocation/{id}": { "get": { "tags": [ "Allocation" ], "summary": "Get a Capacity to Service Version of specified Id", "description": "\nThis method returns the Capacity to Service Version of specified Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetAllocationVersionById", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Capacity to Service Version to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Capacity to Service Version Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationVersionDtoServiceResponse" } } } }, "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. Capacity to Service Version 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/allocation/set/{setId}/version/{versionId}/schema": { "get": { "tags": [ "Allocation" ], "summary": "Get a Capacity to Service Schema by Set, Version Id", "description": "\nThis method returns the Capacity to Service Schema of specified Capacity to Service Set and Version Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetAllocationSchema", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the Capacity to Service Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "in": "path", "description": "The id of the Capacity to Service Version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Capacity to Service Schema Dto is returned", "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. Capacity to Service Set or Version 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": { "get": { "tags": [ "AllocationConfiguration" ], "summary": "Get all Capacity to Service Configurations for the client tenant", "description": "\nThis method returns all Capacity to Service Configurations for given tenant

Required permissions:
Following permissions are required: AllocationConfigurationAccess", "operationId": "GetAllAllocationConfigurations", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Capacity to Service Configurations is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllocationConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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}": { "get": { "tags": [ "AllocationConfiguration" ], "summary": "Get an active version of an existing Capacity to Service Configuration by ID", "description": "\nThis method returns the active, currently in effect, published version for a given Capacity to Service configuration

Required permissions:
Following permissions are required: AllocationConfigurationAccess", "operationId": "GetAllocationConfigurationById", "parameters": [ { "name": "configurationId", "in": "path", "description": "The id of the Capacity to Service configuration to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Capacity to Service Configuration is returned", "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. 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}": { "get": { "tags": [ "AllocationConfiguration" ], "summary": "Get a specific version of an existing Capacity to Service Configuration", "description": "\nThis method returns the specified by number version of a given Capacity to Service configuration

Required permissions:
Following permissions are required: AllocationConfigurationAccess", "operationId": "GetAllocationConfigurationVersionByVersionNumber", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Capacity to Service Configuration version is returned", "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. Capacity to Service Configuration with given version number 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": { "get": { "tags": [ "Configuration" ], "summary": "Get all Configurations for the client tenant", "description": "\nThis method returns all Financial Analysis Configurations for given tenant

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationAccess", "operationId": "GetAllConfigurations", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of Configurations is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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}": { "get": { "tags": [ "Configuration" ], "summary": "Get an active version of an existing Configuration by ID", "description": "\nThis method returns the active, currently in effect, published version for a given configuration

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationAccess", "operationId": "GetConfigurationById", "parameters": [ { "name": "configurationId", "in": "path", "description": "The id of the configuration to retrieve", "required": true, "schema": { "type": "string" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Configuration is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionDtoServiceResponse" } } } }, "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. 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}": { "get": { "tags": [ "Configuration" ], "summary": "Get a specific version of an existing Configuration", "description": "\nThis method returns the specified by number version of a given configuration

Required permissions:
Following permissions are required: FinancialAnalysisConfigurationAccess", "operationId": "GetConfigurationVersionByVersionNumber", "parameters": [ { "name": "configurationId", "in": "path", "description": "The Id of existing model", "required": true, "schema": { "type": "string" } }, { "name": "versionNumber", "in": "path", "description": "The version number to retrieve", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Configuration version is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationVersionDtoServiceResponse" } } } }, "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. Configuration with given version number 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/financialanalysis/set/entity/{entityId}/lite": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get all Financial Analysis Sets by Entity Id without Version data", "description": "\nThis method returns the list of Financial Analysis Set linked to the entity.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialAnalysisSetByEntityId", "parameters": [ { "name": "entityId", "in": "path", "description": "The id of the entity that linked to the Financial Analysis Sets", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A list of Financial Analysis Set Lite Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisSetLiteDtoIEnumerableServiceResponse" } } } }, "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. There is no Financial Analysis for specified entity", "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/set/entity/{entityId}/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get the latest Financial Analysis Version by Entity, Journey, Task Id", "description": "\nThis method returns the latest Financial Analysis Version linked to the task.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialAnalysisSetByEntityJourneyTaskId", "parameters": [ { "name": "entityId", "in": "path", "description": "The id of the entity that linked to the Financial Analysis Sets", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "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": { "200": { "description": "Success. A Financial Analysis Version is returned", "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. Financial Analysis with given ids 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/financialanalysis/set/journey/{journeyId}/task/{taskId}": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get Financial Analysis Sets by Journey, Task Id", "description": "\nThis method returns the Active Financial Analysis Sets in the scope of current task

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialAnalysisSetsByJourneyTaskId", "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": { "200": { "description": "Success. Financial Analysis Sets are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisSetLiteDtoIEnumerableServiceResponse" } } } }, "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. Financial Analysis Sets with given ids do 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/financialanalysis/set/{setId}": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get a Financial Analysis Set of specified Id with all Version data", "description": "\nThis method returns the Financial Analysis Set of specified Id with all Financial Analysis Versions.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialAnalysisSetById", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the Financial Analysis Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Financial Analysis Set is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisVersionsLiteDtoServiceResponse" } } } }, "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. Financial Analysis Set 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/financialanalysis/{id}": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get a Financial Analysis Version of specified Id", "description": "\nThis method returns the Financial Analysis Version of specified Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialAnalysisVersionById", "parameters": [ { "name": "id", "in": "path", "description": "The id of the Financial Analysis Version to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Financial Analysis Version Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialAnalysisVersionDtoServiceResponse" } } } }, "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. Financial Analysis Version 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/financialanalysis/version/{versionId}/scenario": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get a Financial Analysis Scenario By Financial Analysis Version Id", "description": "\nThis method returns the Scenario of specified Financial Analysis Version Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetScenario", "parameters": [ { "name": "versionId", "in": "path", "description": "The id of the Financial Analysis Version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Scenario Version Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScenarioVersionDtoServiceResponse" } } } }, "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. Financial Analysis Scenario with the Version Id 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/version/{versionId}/summary": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get a Financial Analysis Summary By Financial Analysis Version Id", "description": "\nThis method returns the Summary of specified Financial Analysis Version Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetSummary", "parameters": [ { "name": "versionId", "in": "path", "description": "The id of the Financial Analysis Version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Summary Version Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummaryVersionDtoServiceResponse" } } } }, "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. Financial Analysis Summary with the Version Id 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/set/{setId}/version/{versionId}/schema": { "get": { "tags": [ "FinancialAnalysis" ], "summary": "Get a Financial Analysis Schema by Set, Version Id", "description": "\nThis method returns the Financial Analysis Schema of specified Financial Analysis Set and Version Id.

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetSchema", "parameters": [ { "name": "setId", "in": "path", "description": "The Id of the Financial Analysis Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "in": "path", "description": "The id of the Financial Analysis Version", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Financial Analysis Schema Dto is returned", "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. Financial Analysis Set or Version 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/import/{id}": { "get": { "tags": [ "Import" ], "summary": "Get the Financial Import by Id", "description": "\nThis method returns the Financial Import of specified Id

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinancialImportById", "parameters": [ { "name": "id", "in": "path", "description": "The id of the 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" } ], "responses": { "200": { "description": "Success. A Financial Import Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDtoServiceResponse" } } } }, "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. There is no Financial Import for specified Id", "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/entity/{entityId}/journey/{journeyId}": { "get": { "tags": [ "Import" ], "summary": "Get all Financial Imports by Entity and Journey Id", "description": "\nThis method returns the list of Financial Import linked to the entity and journey

Required permissions:
Following permissions are required: FinancialAnalysisAccess", "operationId": "GetFinanciaImportsByEntityAndJourneyId", "parameters": [ { "name": "entityId", "in": "path", "description": "The id of the entity that linked to the Financial Import", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "journeyId", "in": "path", "description": "The id of the journey that linked to the 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" } ], "responses": { "200": { "description": "Success. A list of Financial Import Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportDtoIEnumerableServiceResponse" } } } }, "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. There is no Financial Import for specified entity and journey", "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": { "get": { "tags": [ "ImportProvider" ], "summary": "Get all Import Providers", "description": "\nThis method returns all Import Providers for given tenant.

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetAllImportProviders", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of ImportProviderLiteDto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderLiteDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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}": { "get": { "tags": [ "ImportProvider" ], "summary": "Get the Import Provider by Id with configuration details", "description": "\nThis method returns the Import Provider of specified Id with configuration details

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetImportProviderById", "parameters": [ { "name": "providerId", "in": "path", "description": "The id of the Import Provider", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A Import Provider Dto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportProviderDtoServiceResponse" } } } }, "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. There is no Import Provider for specified Id", "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": { "get": { "tags": [ "ImportProvider" ], "summary": "Get all Import Mappings", "description": "\nThis method returns all Import Mappings for given tenant

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetAllImportMappings", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of ImportMappingDto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "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": { "get": { "tags": [ "ImportProvider" ], "summary": "Get the Import Mapping by Provider Id", "description": "\nThis method returns the Import Mapping of specified Id

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetImportMappingByProviderId", "parameters": [ { "name": "providerId", "in": "path", "description": "The id of the Import Provider", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A ImportMappingDto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportMappingDtoServiceResponse" } } } }, "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. There is no Import Provider for specified Id", "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": { "get": { "tags": [ "ImportProvider" ], "summary": "Get the Adapter Schema by Provider Id", "description": "\nThis method returns the Adapter Schema of specified Id

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetAdapterSchemaByProviderId", "parameters": [ { "name": "providerId", "in": "path", "description": "The id of the Import Provider", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A AdapterSchemaDto is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdapterSchemaDtoServiceResponse" } } } }, "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. There is no Import Provider for specified Id", "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}/configurationSummary": { "get": { "tags": [ "ImportProvider" ], "summary": "Gets a summarised result of the statuses associated with an import provider.", "description": "\nThis method returns a summary of the provider which includes details about the provider itself,\n\nthe configuration, mapping configuration and adapter schema statues for given Provider Id.

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetImportProviderConfigurationSummaryByProviderId", "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": { "200": { "description": "Success. A Configuration Summary is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoServiceResponse" } } } }, "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/configurationSummaries": { "get": { "tags": [ "ImportProvider" ], "summary": "Gets a summarised result of the statuses associated with an import provider.", "description": "\nThis method returns summaries of all providers which includes details about the providers themselves,\n\nthe configuration, mapping configuration and adapter schema statues.

Required permissions:
Following permissions are required: FinancialImportProviderAccess", "operationId": "GetImportProviderConfigurationSummaries", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. A list of Configuration Summaries is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDtoIEnumerableServiceResponse" } } } }, "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/report/set/{setId}/version/{versionId}": { "get": { "tags": [ "Report" ], "summary": "Retrieve a Financial Analysis report for specific version.", "description": "\nThis method returns the Financial Analysis data linked to the specific version.

Required permissions:
Following permissions are required: FinancialAnalysisReport", "operationId": "GetFinancialAnalysisReportBySetIdAndVersionId", "parameters": [ { "name": "setId", "in": "path", "description": "The id of Financial Analysis Set", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "versionId", "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" } ], "responses": { "200": { "description": "Success. A Financial Analysis report is returned in csv format.", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Financial Analysis with given ids 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" } ] } } } } } } } }, "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", "format": "uuid" }, "providerId": { "type": "string", "description": "Provider Id of the schema", "format": "uuid" }, "schema": { "allOf": [ { "$ref": "#/components/schemas/SchemaDto" } ], "description": "The schema contains request and result schema", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema" }, "AdapterSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AdapterSchemaDto" } ], "description": "Adapter Configuration Schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Capacity to Service Configuration Id", "format": "uuid", "example": "df484b73-eadb-40af-8f61-2a6ca7e9d6d6" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationConfigurationVersionDto" }, "description": "List of available Capacity to Service configuration versions", "nullable": true } }, "additionalProperties": false, "description": "Capacity to Service Configuration Data" }, "AllocationConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationConfigurationVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "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": { "allOf": [ { "$ref": "#/components/schemas/StandardValidationDataDto" } ], "description": "Standard Validation Data - set of validation rules for the Capacity to Service Config", "nullable": true }, "allocationValidationData": { "allOf": [ { "$ref": "#/components/schemas/AllocationValidationDataDto" } ], "description": "Allocation Validation Data - set of business validation rules for the Capacity to Service Config", "nullable": true }, "conditionOperators": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorDto" }, "description": "List of scooping 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" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query", "example": true }, "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 }, "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/AllocationEntityTypeConfigurationDto" }, "description": "It holds the configuration of the entity types", "nullable": true } }, "additionalProperties": false, "description": "Instance of Capacity to Service Configuration Version" }, "AllocationConfigurationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AllocationConfigurationVersionDto" } ], "description": "Instance of Capacity to Service Configuration Version", "nullable": true }, "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 }, "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 }, "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": { "allOf": [ { "$ref": "#/components/schemas/StandardValidationDataDto" } ], "description": "Validation Rule", "nullable": true }, "allocationValidationData": { "allOf": [ { "$ref": "#/components/schemas/AllocationValidationDataDto" } ], "description": "Validation Rule", "nullable": true }, "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": { "allOf": [ { "$ref": "#/components/schemas/AllocationSchemaDto" } ], "description": "Model that contains information to build capacity to service schema", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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" }, "allocationVersions": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationVersionDto" }, "description": "List of Capacity to Service Versions", "nullable": true } }, "additionalProperties": false, "description": "Capacity to Service Set representation" }, "AllocationSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AllocationSetDto" } ], "description": "Capacity to Service Set representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationValidationDataDto": { "type": "object", "properties": { "onlyIndividualsCanAllocate": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Allocation Rule - does not allow individuals to receive allocation from non-individuals", "nullable": true }, "totalAllocationLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Allocation Rule - does not allow total allocation outside the range", "nullable": true } }, "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 }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "lastUpdatedDateTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "versionNumber": { "type": "integer", "description": "Capacity to Service Version", "format": "int32", "example": 1 }, "isAllocationsDisabledByUser": { "type": "boolean", "description": "Indicates whether the Allocations Grid is disabled by user in UI" } }, "additionalProperties": false, "description": "Capacity to Service Version representation" }, "AllocationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AllocationVersionDto" } ], "description": "Capacity to Service Version representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "AllocationVersionLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Capacity to Service GUiD", "format": "uuid", "example": "55509731-77df-4e72-98e7-0d314b7a5151" }, "allocationSetId": { "type": "string", "description": "Capacity to Service GUiD", "format": "uuid", "example": "1239731-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" }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "lastUpdatedTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "versionNumber": { "type": "integer", "description": "Capacity to Service Version", "format": "int32", "example": 1 }, "isAllocationsDisabledByUser": { "type": "boolean", "description": "Indicates whether the Allocations Grid is disabled by user in UI" } }, "additionalProperties": false, "description": "FinancialAnalysisVersions representation" }, "AllocationVersionsLiteDto": { "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" }, "allocationVersions": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationVersionLiteDto" }, "description": "List of Capacity to Service Versions", "nullable": true } }, "additionalProperties": false, "description": "Capacity to Service Set representation" }, "AllocationVersionsLiteDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AllocationVersionsLiteDto" } ], "description": "Capacity to Service Set representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ApproveAction": { "type": "object", "properties": { "comment": { "type": "string", "nullable": true }, "decision": { "allOf": [ { "$ref": "#/components/schemas/Decision" } ] }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Approver": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "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": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto2" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "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": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto2" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "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": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto2" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "ColumnSummaryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Column id", "nullable": true }, "value": { "type": "string", "description": "Calculated value", "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" }, "ConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Configuration Id", "format": "uuid", "example": "df484b73-eadb-40af-8f61-2a6ca7e9d6d6" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationVersionDto" }, "description": "List of available configuration versions", "nullable": true } }, "additionalProperties": false, "description": "Configuration Data" }, "ConfigurationDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ConfigurationVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the version", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "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, "example": [ "expenseType", "incomeType", "assetType" ] }, "conditionOperators": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionOperatorDto" }, "description": "List of scooping 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" }, "publicationDate": { "type": "string", "description": "The date that the version got published", "format": "date-time", "nullable": true, "example": "2021-12-12T15:55:00.000Z" }, "status": { "allOf": [ { "$ref": "#/components/schemas/VersionStatus" } ], "description": "The status of the version", "example": "Draft" }, "created": { "type": "string", "description": "The creation date of the version", "format": "date-time", "example": "2021-12-12T15:55:00.000Z" }, "isActive": { "type": "boolean", "description": "The calculated flag to annotate whether this is the model's active version\nat the time of the query", "example": true }, "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": "Instance of Configuration Version" }, "ConfigurationVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ConfigurationVersionDto" } ], "description": "Instance of Configuration Version", "nullable": true }, "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": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDtoConditionalValidationRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDtoValidationRuleDto" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true }, "readOnly": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDtoConditionalValidationRuleDto" } ], "description": "Validation rule that allows to set if field should be read only", "nullable": true } }, "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": { "allOf": [ { "$ref": "#/components/schemas/EmptyRuleDto" } ], "description": "Static validation rule always applied when active", "nullable": true } }, "additionalProperties": false, "description": "Represent the configuration of the validation rule" }, "ErrorDto": { "type": "object", "properties": { "message": { "type": "string", "description": "Error message", "nullable": true } }, "additionalProperties": false }, "FieldDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the field", "nullable": true, "example": "" }, "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" }, "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, "example": "2db6a893-8e1c-4b0c-b1f9-4b84d86fcf45" }, "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": "Values of the Financial Item per period", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Data to be used to derive initial 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": { "allOf": [ { "$ref": "#/components/schemas/ScenarioSchema" } ], "description": "Scenario schemas that contain scenario information", "nullable": true }, "summarySchema": { "allOf": [ { "$ref": "#/components/schemas/SummarySchema" } ], "description": "Summary schemas that contain summary information", "nullable": true } }, "additionalProperties": false, "description": "Model that contains information to build financial analysis schema" }, "FinancialAnalysisSchemaDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FinancialAnalysisSchemaDto" } ], "description": "Model that contains information to build financial analysis schema", "nullable": true }, "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" }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "List of entities that financial analysis set belongs to for Joint", "nullable": true }, "isExternalReviewRequired": { "type": "boolean", "description": "Is External Review required for Financial Analysis Set", "example": false }, "financialAnalysisVersions": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAnalysisVersionDto" }, "description": "List of Financial Analysis Versions", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Set representation" }, "FinancialAnalysisSetDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FinancialAnalysisSetDto" } ], "description": "Financial Analysis Set representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialAnalysisSetLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis UiD", "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": "54953531-77df-4e72-98e7-0d314b7a5151" }, "taskId": { "type": "string", "description": "Task Id which financial analysis belongs", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "status": { "type": "string", "description": "Financial Analysis Set Status", "nullable": true, "example": "Draft" }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "List of entities that financial analysis set belongs to for Joint", "nullable": true }, "isExternalReviewRequired": { "type": "boolean", "description": "Is External Review required for Financial Analysis Set", "example": false } }, "additionalProperties": false, "description": "Financial Analysis Set Lite representation" }, "FinancialAnalysisSetLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialAnalysisSetLiteDto" }, "nullable": true }, "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" }, "externalReviewStatus": { "type": "string", "description": "External Review Status for this Version", "nullable": true, "example": "Pending" }, "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 that capture the commentary for the financial analysis", "nullable": true }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "lastUpdatedDateTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "versionNumber": { "type": "integer", "description": "Financial Analysis Version", "format": "int32", "example": 1 }, "importRecords": { "type": "array", "items": { "$ref": "#/components/schemas/ImportRecordDto" }, "description": "Import applied to financial analysis version logs", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Version representation" }, "FinancialAnalysisVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FinancialAnalysisVersionDto" } ], "description": "Financial Analysis Version representation", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FinancialAnalysisVersionsLiteDto": { "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" }, "entitiesList": { "type": "array", "items": { "$ref": "#/components/schemas/JointEntityDto" }, "description": "List of entities that financial analysis set belongs to for Joint", "nullable": true }, "financialAnalysisVersions": { "type": "array", "items": { "$ref": "#/components/schemas/VersionLiteDto" }, "description": "List of Financial Analysis Versions", "nullable": true } }, "additionalProperties": false, "description": "Financial Analysis Set representation with Lite Financial Analysis Versions" }, "FinancialAnalysisVersionsLiteDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FinancialAnalysisVersionsLiteDto" } ], "description": "Financial Analysis Set representation with Lite Financial Analysis Versions", "nullable": true }, "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 Analysis", "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": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data Field", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "description": "Validation Rule", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Validation Rules V2", "nullable": true }, "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": "e1809731-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" }, "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 }, "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" } }, "additionalProperties": false, "description": "Financial Item" }, "ImportDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Import GUID", "format": "uuid", "example": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "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" }, "providerId": { "type": "string", "description": "Provider Id linked to the import", "format": "uuid", "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "externalId": { "type": "string", "description": "External Id used to refer the import in external system", "format": "uuid", "nullable": true, "example": "2c3c8433-efc3-493b-9b14-70b7681c7342" }, "status": { "type": "string", "description": "Status of the import", "nullable": true, "example": "Failed" }, "importParameters": { "description": "Parameters that is used to issue import request", "nullable": true }, "createdOn": { "type": "string", "description": "UTC time of creation of the import", "format": "date-time", "example": "2022-11-14T09:00:00" }, "updatedOn": { "type": "string", "description": "UTC time of last update of the import", "format": "date-time", "nullable": true, "example": "2022-11-14T11:00:00" }, "result": { "allOf": [ { "$ref": "#/components/schemas/ResultDto" } ], "description": "Import result data", "nullable": true }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorDto" }, "description": "List of error information of the import", "nullable": true } }, "additionalProperties": false }, "ImportDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ImportDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportMappingDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "providerId": { "type": "string", "format": "uuid" }, "importRequestDto": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The import mapping request schema for request", "nullable": true }, "importResultDto": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The import mapping result schema for request", "nullable": true } }, "additionalProperties": false, "description": "Import Mapping Schema" }, "ImportMappingDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportMappingDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportMappingDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ImportMappingDto" } ], "description": "Import Mapping Schema", "nullable": true }, "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": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationDto" } ], "nullable": true } }, "additionalProperties": false }, "ImportProviderDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ImportProviderDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportProviderLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Import Provider GUID", "format": "uuid", "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "systemId": { "type": "string", "description": "System id for Default Providers", "nullable": true, "example": "54953531-77df-4e72-98e7-0d314b7a5151" }, "name": { "type": "string", "description": "Provider Name", "nullable": true, "example": "ABC" }, "enabled": { "type": "boolean", "description": "If the provider is enabled", "example": false } }, "additionalProperties": false, "description": "Create Import Provider Response Dto" }, "ImportProviderLiteDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ImportProviderLiteDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ImportRecordDto": { "type": "object", "properties": { "providerId": { "type": "string", "description": "Import Provider Id", "format": "uuid" }, "importId": { "type": "string", "description": "Financial Import Id", "format": "uuid" }, "importUpdatedOn": { "type": "string", "description": "Updated time or the import", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "JointEntityDto": { "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "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" }, "includingNestedPath": { "type": "boolean", "description": "If true, it will find all properties (including nested properties) with this Property Name" } }, "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": { "allOf": [ { "$ref": "#/components/schemas/MappingDto" } ], "description": "The nested mapping rules for mapping a nested object", "nullable": true }, "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": { } }, "PropertyType": { "enum": [ "Single", "Custom", "Collection" ], "type": "string" }, "ProviderConfigurationDto": { "type": "object", "properties": { "providerDetailsDtos": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderDetailsDto" }, "nullable": true }, "adapterConfigurationDto": { "allOf": [ { "$ref": "#/components/schemas/AdapterConfigurationDto" } ], "nullable": true }, "securityKeysDto": { "allOf": [ { "$ref": "#/components/schemas/SecurityKeysDto" } ], "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "providerId": { "type": "string", "format": "uuid" }, "systemId": { "type": "string", "nullable": true }, "mappingStatus": { "type": "string", "nullable": true }, "adapterStatus": { "type": "string", "nullable": true }, "authenticationStatus": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "isCustom": { "type": "boolean" } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProviderConfigurationSummaryDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ProviderConfigurationSummaryDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "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 }, "ResultDto": { "type": "object", "properties": { "importResult": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Mapped imported result", "nullable": true } }, "additionalProperties": false }, "ScenarioColumnDefinitionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Scenario Definition Id", "format": "uuid", "example": "e9ed602b-e38f-4b20-8ef4-9dcce57058ec" }, "name": { "type": "string", "description": "Scenario Definition Name", "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": 2020 }, "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": "" } }, "additionalProperties": false }, "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 periods captured in this Scenario Analysis", "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": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data Field", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "description": "Validation Rule", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Validation Rules V2", "nullable": true }, "financialAnalysisConfiguration": { "allOf": [ { "$ref": "#/components/schemas/FinancialAnalysisConfiguration" } ], "description": "Contains information from Financial Analysis Configuration for the schema to use, mainly for validation", "nullable": true } }, "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": "e1809731-77df-4e72-98e7-0d314b7a5151" }, "foreignId": { "type": "string", "description": "Scenario Item Foreign Id if it is cloned from other item", "nullable": true, "example": "8def808a-f6f3-44e7-b466-1f033de656b3" }, "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": "Manual" }, "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": " Scenario Definition Id \n///", "format": "uuid", "example": "e9ed602b-e38f-4b20-8ef4-9dcce57058ec" }, "value": { "type": "string", "description": "Scenario Value", "nullable": true, "example": "Earthquake" } }, "additionalProperties": false, "description": "Value of a scenario item for a specific scenario" }, "ScenarioVersionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis Version GUiD", "format": "uuid", "example": "e1809731-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 that capture the commentary for the financial analysis scenario", "nullable": true } }, "additionalProperties": false }, "ScenarioVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ScenarioVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "SchemaDto": { "type": "object", "properties": { "importRequest": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration request schema \nIt contains list of fields", "nullable": true }, "importResult": { "allOf": [ { "$ref": "#/components/schemas/SchemaEntryDto" } ], "description": "Adapter Configuration result schema \nIt contains list of fields", "nullable": true } }, "additionalProperties": false, "description": "Adapter Configuration Schema Detail" }, "SchemaEntryDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDto" }, "description": "The list of all Fields", "nullable": true } }, "additionalProperties": false }, "SecurityKeysDto": { "type": "object", "properties": { "authenticationKey": { "type": "string", "nullable": true }, "encryptionKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Signee": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "successor": { "allOf": [ { "$ref": "#/components/schemas/Approver" } ], "nullable": true }, "action": { "allOf": [ { "$ref": "#/components/schemas/ApproveAction" } ], "nullable": true }, "hasProcessedRequest": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SinglePropertyDto": { "type": "object", "properties": { "type": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "discriminator": { "allOf": [ { "$ref": "#/components/schemas/PropertyType" } ], "readOnly": true }, "isValid": { "type": "boolean", "nullable": true }, "value": { "type": "string", "nullable": true }, "valueId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StandardValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "onlyInteger": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows only integers", "nullable": true }, "noNegative": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that does not allow negative numbers", "nullable": true }, "onlyDecimal": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Validation rule that allows numbers up to two decimal places", "nullable": true }, "numberLimit": { "allOf": [ { "$ref": "#/components/schemas/ValueLimitRuleDto" } ], "description": "Validation rule that allows to set number range", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing validation data metadata" }, "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 Id", "format": "uuid", "example": "e9ed602b-e38f-4b20-8ef4-9dcce57058ec" }, "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 Id from Actual or Scenario", "nullable": true, "example": "" } }, "additionalProperties": false }, "SummaryGroupDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Summary Group Id", "format": "uuid", "example": "c59e9893-1741-4dd8-bb99-3975c7f30c7d" }, "actualGroupId": { "type": "string", "description": "Actual Group Id", "nullable": true, "example": "89c524db-1bac-4432-b8d5-f6704e16fa6a" }, "scenarioGroupId": { "type": "string", "description": "Scenario Group Id", "nullable": true, "example": "c3d79d3e-8d4f-42b9-8fac-09d2243d605c" }, "name": { "type": "string", "description": "Summary Group Name", "nullable": true, "example": "Natural Disaster" }, "type": { "type": "string", "description": "Summary Group Type", "nullable": true, "example": "Manual" }, "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", "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": { "allOf": [ { "$ref": "#/components/schemas/DataFieldDto" } ], "description": "Data Field", "nullable": true }, "order": { "type": "number", "description": "Order", "format": "double", "nullable": true, "example": 1 }, "validationRule": { "allOf": [ { "$ref": "#/components/schemas/ValidationRuleDto" } ], "description": "Validation Rule", "nullable": true }, "validationRulesV2": { "allOf": [ { "$ref": "#/components/schemas/DataValidationRulesDto" } ], "description": "Validation Rules V2", "nullable": true } }, "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": "0b712cf4-1d10-43ba-880b-49354e2db97e" }, "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, "description": "Summary Item" }, "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": " Summary Column Id \n///", "format": "uuid", "example": "e9ed602b-e38f-4b20-8ef4-9dcce57058ec" }, "value": { "type": "string", "description": "Summary Value", "nullable": true, "example": "100" } }, "additionalProperties": false }, "SummaryVersionDto": { "type": "object", "properties": { "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 }, "SummaryVersionDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/SummaryVersionDto" } ], "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationDataDto": { "type": "object", "properties": { "isMandatory": { "allOf": [ { "$ref": "#/components/schemas/BasicRuleDto" } ], "description": "Mandatory Rule - does not allow empty value", "nullable": true }, "collectionMinimumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMinimumCountRuleDto" } ], "description": "Validation rule that allows to set minimum count requirements for collection", "nullable": true }, "collectionMaximumCount": { "allOf": [ { "$ref": "#/components/schemas/CollectionMaximumCountRuleDto" } ], "description": "Validation rule that allows to set maximum count requirements for collection", "nullable": true } }, "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": { "allOf": [ { "$ref": "#/components/schemas/ValidationDataDto" } ], "description": "Validation Data - set of validation rules specific to requirement/data group field", "nullable": true } }, "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" }, "VersionLiteDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Financial Analysis GUiD", "format": "uuid", "example": "55509731-77df-4e72-98e7-0d314b7a5151" }, "financialAnalysisSetId": { "type": "string", "description": "Financial Analysis GUiD", "format": "uuid", "example": "1239731-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" }, "externalReviewStatus": { "type": "string", "description": "External Review Status for this Version", "nullable": true, "example": "Pending" }, "createdDateTime": { "type": "string", "description": "Date time it was created (Read-only)", "format": "date-time", "example": "2020-12-12T15:55:00.000Z" }, "lastUpdatedTime": { "type": "string", "description": "Last time it was updated (Read-only)", "format": "date-time", "example": "2022-12-12T15:55:00.000Z" }, "versionNumber": { "type": "integer", "description": "Financial Analysis Version", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "FinancialAnalysisVersions representation" }, "VersionStatus": { "enum": [ "Draft", "Pending", "Rejected", "Published", "Archived", "Deleted" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }