openapi: 3.2.0 info: title: Fenergo Allocation Configuration API version: '1.0' description: 'Operations tagged AllocationConfiguration across 2 of this provider''s published API definitions: fenergo-financialanalysiscommand-v1-0-openapi.json, fenergo-financialanalysisquery-v1-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /financialanalysiscommand - url: /financialanalysisquery security: - Bearer: [] tags: - name: AllocationConfiguration paths: /api/configuration/allocation: post: tags: - AllocationConfiguration summary: Create a new Capacity to Service Configuration description: 'Creates a new Capacity to Service Configuration Required permissions: Following permissions are required: AllocationConfigurationCreate' operationId: CreateAllocationConfiguration parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Create Capacity to Service Configuration request content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionDtoServiceRequest' responses: '202': description: Success. Capacity to Service Configuration created content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AllocationConfiguration summary: Get all Capacity to Service Configurations for the client tenant description: 'This 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 servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}: delete: tags: - AllocationConfiguration summary: Delete Capacity to Service Configuration and all it's versions description: 'This method deletes an existing Capacity to Service Configuration as well as all its versions. Required permissions: Following permissions are required: AllocationConfigurationDelete' operationId: DeleteAllocationConfiguration parameters: - name: configurationId in: path description: Configuration Id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT post: tags: - AllocationConfiguration summary: Create a new Version for an existing Capacity to Service Configuration description: 'This method creates a new Capacity to Service Configuration version. The new version initializes with the DTO data. It is assigned the next available version number, the default status of Draft and the Author as the only required Signee. Required permissions: Following permissions are required: AllocationConfigurationCreate' operationId: CreateAllocationConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the new version data content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionDtoServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionDtoServiceResponse' '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AllocationConfiguration summary: Get an active version of an existing Capacity to Service Configuration by ID description: 'This 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_2' '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 servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}/version/{versionNumber}/clone: post: tags: - AllocationConfiguration summary: Clone a Capacity to Service Configuration description: 'Clones the selected version of existing Capacity to Service configuration and creates a new model with a single version The new version contain all the data of the original selected one, will have the default status of draft and the author as the only required signee. Required permissions: Following permissions are required: AllocationConfigurationEdit' operationId: CloneAllocationConfiguration parameters: - name: configurationId in: path description: Capacity to Service Configuration Id required: true schema: type: string format: uuid - name: versionNumber in: path description: Version number to clone required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Clone Capacity to Service Configuration version request content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationCloneRequestDtoServiceRequest' responses: '202': description: Success. Capacity to Service Configuration cloned content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationClonedResponseDtoServiceResponse' '400': description: Bad request. The request has missing/invalid values content: application/json: schema: $ref: '#/components/schemas/ServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Not Found. Capacity to Service Configuration with given id does not exist type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}/version/{versionNumber}: put: tags: - AllocationConfiguration summary: Updates an existing Version of a Capacity to Service Configuration description: 'This method updates an existing Capacity to Service Configuration version. Only Draft and Rejected versions are allowed to be updated. Required permissions: Following permissions are required: AllocationConfigurationEdit' operationId: UpdateAllocationConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: Number of version to update required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the updated version data content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionDtoServiceRequest' responses: '202': description: Accepted for processing '400': description: Invalid request content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT get: tags: - AllocationConfiguration summary: Get a specific version of an existing Capacity to Service Configuration description: 'This 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_2' '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 servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}/version/{versionNumber}/submit-for-approval: put: tags: - AllocationConfiguration summary: Submit an existing Version of a Capacity to Service Configuration for Approval description: 'This method submits the selected version of an existing Capacity to Service Configuration for Approval. Required permissions: Following permissions are required: AllocationConfigurationCreate' operationId: SubmitAllocationConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to submit required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}/version/{versionNumber}/sign: put: tags: - AllocationConfiguration summary: Sign an existing Version of a Capacity to Service Configuration description: 'This method signs the selected version of an existing Capacity to Service Configuration. The Status of the version changes according to the action sent (Approve/Reject). Required permissions: Following permissions are required: AllocationConfigurationApprove' operationId: SignAllocationConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to sign required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: ServiceRequest with the Fenergo.Nebula.Versioning.Models.ApproveAction signing data content: application/json: schema: $ref: '#/components/schemas/ApproveActionServiceRequest' responses: '202': description: Accepted for processing content: application/json: schema: $ref: '#/components/schemas/AllocationConfigurationVersionSignedResponseDtoServiceResponse' '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand /api/configuration/allocation/{configurationId}/version/{versionNumber}/archive: put: tags: - AllocationConfiguration summary: Archive an existing Version of a Capacity to Service Configuration description: 'This method archives the selected version of an existing Capacity to Service Configuration. Required permissions: Following permissions are required: AllocationConfigurationArchive' operationId: ArchiveAllocationConfigurationVersion parameters: - name: configurationId in: path description: The Id of the existing model required: true schema: type: string format: uuid - name: versionNumber in: path description: The version number of the version to archive required: true schema: type: integer format: int32 - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted for processing '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationErrorModelListServiceResponse' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: Capacity to Service Configuration with given ID does not exists type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /financialanalysiscommand components: schemas: AllocationConfigurationClonedResponseDto: type: object properties: configurationId: type: string description: Id of cloned configuration format: uuid example: c18a8634-b259-46fc-90c2-19ff2b24d85e additionalProperties: false description: Configuration Clone response data AllocationValidationDataDto: type: object properties: onlyIndividualsCanAllocate: $ref: '#/components/schemas/BasicRuleDto' totalAllocationLimit: $ref: '#/components/schemas/ValueLimitRuleDto' additionalProperties: false description: Request DTO representing business validation data metadata AllocationConfigurationVersionDto: type: object properties: id: type: string description: Capacity to Service Configuration Id format: uuid example: e1809731-77df-4e72-98e7-0d314b7a5151 configurationId: type: string description: Capacity to Service Configuration Id format: uuid example: 22bf9ef9-0535-4d9b-a61e-9945cdf508cb name: type: - string - 'null' description: Capacity to Service Configuration's name example: Individuals Only periodType: type: - string - 'null' description: Type of Period 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 - 'null' description: Prefix you want to set before period references example: FY businessCategory: type: - string - 'null' description: Capacity to Service business category example: Basic Details validationData: $ref: '#/components/schemas/StandardValidationDataDto' allocationValidationData: $ref: '#/components/schemas/AllocationValidationDataDto' conditionOperators: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorDto' description: List of scoping conditions versionNumber: type: integer description: Version Number format: int32 example: 2 effectiveFrom: type: string description: The date that the version takes effect when published format: date-time example: '2021-12-12T15:55:00.000Z' signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee' description: The defined list of signees/approvals of the version totalRowDataGroupId: type: - string - 'null' description: The Id of the data group used to derive a CTS total row initial figure deprecated: true totalRowFinancialItem: type: - string - 'null' description: The name of the financial item used to derive a CTS total row initial figure deprecated: true financialAnalysisType: type: - string - 'null' description: The financial analysis type that the Allocations are applicable to example: Scenario allocationContext: type: - array - 'null' items: type: string description: Entity types that the configuration is applicable to example: - Company - Deal - Joint allocationEntityTypeConfigurations: type: - array - 'null' items: $ref: '#/components/schemas/AllocationEntityTypeConfigurationDto' description: It holds the configuration of the entity types additionalProperties: false description: Set of properties which define new version of Capacity to Service Configuration AllocationConfigurationVersionSignedResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/AllocationConfigurationVersionSignedResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AllocationConfigurationVersionDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AllocationConfigurationVersionDto' additionalProperties: false Signee: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false AllocationConfigurationClonedResponseDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/AllocationConfigurationClonedResponseDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ValueLimitRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred minValue: type: - integer - 'null' description: Minimum value format: int32 example: 1 maxValue: type: - integer - 'null' description: Maximum value format: int32 example: 10 additionalProperties: false description: Request DTO representing value limit rule metadata BasicRuleDto: type: object properties: active: type: boolean description: Validation rule active flag example: true message: type: - string - 'null' description: Validation rule error message example: Validation error occurred additionalProperties: false description: Request DTO representing basic validation rule metadata StandardValidationDataDto: type: object properties: isMandatory: $ref: '#/components/schemas/BasicRuleDto' onlyInteger: $ref: '#/components/schemas/BasicRuleDto' noNegative: $ref: '#/components/schemas/BasicRuleDto' onlyDecimal: $ref: '#/components/schemas/BasicRuleDto' numberLimit: $ref: '#/components/schemas/ValueLimitRuleDto' additionalProperties: false description: Request DTO representing validation data metadata ConditionOperatorDto: type: object properties: id: type: string description: Id format: uuid example: 38c8bc5c-364a-4213-a1e9-7fc5541de823 logicalOperator: type: - string - 'null' description: Logical operator example: And conditionName: type: - string - 'null' description: Condition Name example: APAC Agricultural Company conditionDescription: type: - string - 'null' description: Condition Description example: Entity type and company requirements conditionOperatorItems: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorItemDto' description: Condition Operator Items additionalProperties: false description: Set of properties which define a Scoping Condition Operator AllocationEntityTypeConfigurationDto: type: object properties: entityType: type: - string - 'null' description: Entity Type of the configuration. example: Individual surplusDeficitDataGroupId: type: - string - 'null' description: The Id of the data group used to derive a CTS total row initial figure. example: 123f8be3-f29b-4959-8964-956d4af7c468 surplusDeficitFinancialItem: type: - string - 'null' description: The name of the financial item used to derive a CTS total row initial figure. example: EBITDA identifiersDataGroupId: type: - string - 'null' description: The Id of the data group which will be use to identify statements. example: 123f8be3-f29b-4959-8964-956d4af7c468 identifiersFinancialItem: type: - array - 'null' items: type: string description: The financial items which will match with other entities. example: - StatementDate - Periods detailsDataGroupId: type: - string - 'null' description: The Id of the data group used to show financial details. example: 123f8be3-f29b-4959-8964-956d4af7c468 detailsFinancialItem: type: - array - 'null' items: type: string description: The names of the financial items used to show financial details. example: - Revenue - EBITDA additionalProperties: false AllocationConfigurationCloneRequestDtoServiceRequest: type: object properties: data: $ref: '#/components/schemas/AllocationConfigurationCloneRequestDto' additionalProperties: false AllocationConfigurationCloneRequestDto: type: object properties: name: type: - string - 'null' description: Name of cloned configuration example: Configuration Clone additionalProperties: false description: Configuration Clone response data ServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Decision: enum: - Approve - Reject type: string ApproveActionServiceRequest: type: object properties: data: $ref: '#/components/schemas/ApproveAction' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver: type: object properties: subject: type: - string - 'null' successor: $ref: '#/components/schemas/Approver' action: $ref: '#/components/schemas/ApproveAction' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false AllocationConfigurationVersionSignedResponseDto: type: object properties: configurationId: type: string description: The Id of the configuration the version belongs to format: uuid versionNumber: type: integer description: The version number that has been signed format: int32 status: $ref: '#/components/schemas/VersionStatus' additionalProperties: false description: Contains the new version Status, after a version sign operation ValidationErrorModelListServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/ValidationErrorModel' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false example: data: - propertyName: data errorMessage: Data is required attemptedValue: '' errorCode: NotNullValidator messages: - message: Data is required type: Error errorCode: Error Code ConditionOperatorItemDto: type: object properties: id: type: string description: Id format: uuid example: 8be001f1-2120-49ff-b4ca-87cb279ae7b7 dataSource: type: - string - 'null' description: 'Source of Datakey: currentEntity' example: currentEntity dataKey: type: - string - 'null' description: Datakey example: entityType logicalOperator: type: - string - 'null' description: 'Logical Operator includes: Equals, NotEquals, In, NotIn, Defined, NotDefined' example: Equals value: type: - array - 'null' items: type: string description: Assigned Value example: - Company valueType: type: - string - 'null' description: 'Value Type: text, select, multiselect, number, date' example: text additionalProperties: false description: Set of properties which define a Condition Operator Item ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' errorMessage: type: - string - 'null' attemptedValue: {} errorCode: type: - string - 'null' additionalProperties: false VersionStatus: enum: - Draft - Pending - Rejected - Published - Archived - Deleted type: string ApproveAction: type: object properties: comment: type: - string - 'null' decision: $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false AllocationConfigurationVersionDtoServiceResponse: type: object properties: data: $ref: '#/components/schemas/AllocationConfigurationVersionDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false AllocationValidationDataDto_2: type: object properties: onlyIndividualsCanAllocate: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Allocation Rule - does not allow individuals to receive allocation from non-individuals totalAllocationLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Allocation Rule - does not allow total allocation outside the range additionalProperties: false description: Request DTO representing business validation data metadata AllocationConfigurationVersionDto_2: 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 - 'null' description: Capacity to Service Configuration's name example: Individuals Only periodType: type: - string - 'null' description: Type of Period 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 - 'null' description: Prefix you want to set before period references example: FY businessCategory: type: - string - 'null' description: Capacity to Service business category example: Basic Details validationData: allOf: - $ref: '#/components/schemas/StandardValidationDataDto_2' description: Standard Validation Data - set of validation rules for the Capacity to Service Config allocationValidationData: allOf: - $ref: '#/components/schemas/AllocationValidationDataDto_2' description: Allocation Validation Data - set of business validation rules for the Capacity to Service Config conditionOperators: type: - array - 'null' items: $ref: '#/components/schemas/ConditionOperatorDto' description: List of scooping conditions 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 - 'null' description: The date that the version got published format: date-time 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 at the time of the query' example: true signees: type: - array - 'null' items: $ref: '#/components/schemas/Signee_2' description: The defined list of signees/approvals of the version totalRowDataGroupId: type: - string - 'null' description: The Id of the data group used to derive a CTS total row initial figure totalRowFinancialItem: type: - string - 'null' description: The name of the financial item used to derive a CTS total row initial figure financialAnalysisType: type: - string - 'null' description: The financial analysis type that the Allocations are applicable to allocationContext: type: - array - 'null' items: type: string description: Entity types that the configuration is applicable to allocationEntityTypeConfigurations: type: - array - 'null' items: $ref: '#/components/schemas/AllocationEntityTypeConfigurationDto_2' description: It holds the configuration of the entity types additionalProperties: false description: Instance of Capacity to Service Configuration Version Signee_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: true additionalProperties: false AllocationConfigurationDtoIEnumerableServiceResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/AllocationConfigurationDto' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StandardValidationDataDto_2: type: object properties: isMandatory: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Mandatory Rule - does not allow empty value onlyInteger: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows only integers noNegative: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that does not allow negative numbers onlyDecimal: allOf: - $ref: '#/components/schemas/BasicRuleDto' description: Validation rule that allows numbers up to two decimal places numberLimit: allOf: - $ref: '#/components/schemas/ValueLimitRuleDto' description: Validation rule that allows to set number range additionalProperties: false description: Request DTO representing validation data metadata AllocationEntityTypeConfigurationDto_2: type: object properties: entityType: type: - string - 'null' description: Entity Type of the configuration. surplusDeficitDataGroupId: type: - string - 'null' description: The Id of the data group used to derive a CTS total row initial figure. surplusDeficitFinancialItem: type: - string - 'null' description: The name of the financial item used to derive a CTS total row initial figure. identifiersDataGroupId: type: - string - 'null' description: The Id of the data group which will be use to identify statements. identifiersFinancialItem: type: - array - 'null' items: type: string description: The financial items which will match with other entities. detailsDataGroupId: type: - string - 'null' description: The Id of the data group used to show financial details. detailsFinancialItem: type: - array - 'null' items: type: string description: The names of the financial items used to show financial details. additionalProperties: false AllocationConfigurationVersionDtoServiceResponse_2: type: object properties: data: allOf: - $ref: '#/components/schemas/AllocationConfigurationVersionDto_2' description: Instance of Capacity to Service Configuration Version messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false Approver_2: type: object properties: subject: type: - string - 'null' successor: allOf: - $ref: '#/components/schemas/Approver_2' action: allOf: - $ref: '#/components/schemas/ApproveAction_2' hasProcessedRequest: type: boolean readOnly: 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 - 'null' items: $ref: '#/components/schemas/AllocationConfigurationVersionDto_2' description: List of available Capacity to Service configuration versions additionalProperties: false description: Capacity to Service Configuration Data ApproveAction_2: type: object properties: comment: type: - string - 'null' decision: allOf: - $ref: '#/components/schemas/Decision' created: type: string format: date-time additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-financialanalysiscommand-v1-0-openapi.json - fenergo-financialanalysisquery-v1-0-openapi.json