openapi: 3.1.0 info: title: Value Proposition version: 0.1.0 x-api-evangelist-source: https://api.xfactor.io/v1/value-proposition/openapi.json paths: /healthz: get: tags: - health summary: Health description: Provides information about the health of the application operationId: health_healthz_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/HealthCheckResponse' /v1/value-proposition/list: get: tags: - list summary: Get the list of Value Propositions description: "Endpoint for reading the Value Propositions available to the user\n\nReturns\n-------\ndict\n Returns\ \ the list of available Value Propositions and has_unfinished_vps" operationId: get_value_proposition_list_v1_value_proposition_list_get security: - HTTPBearer: [] parameters: - name: include_calcs in: query required: false schema: anyOf: - type: boolean - type: 'null' description: Include calculator VPs default: false title: Include Calcs description: Include calculator VPs - name: skip_solutions in: query required: false schema: anyOf: - type: integer - type: 'null' description: Skip loading solutions (0 or 1) default: 0 title: Skip Solutions description: Skip loading solutions (0 or 1) - name: sortby in: query required: false schema: anyOf: - type: string - type: 'null' description: Column to sort by default: v.modified title: Sortby description: Column to sort by - name: order in: query required: false schema: anyOf: - type: string - type: 'null' description: Sort order (ASC or DESC) default: DESC title: Order description: Sort order (ASC or DESC) - name: limit in: query required: false schema: anyOf: - type: string - type: 'null' description: Limit number of results default: all title: Limit description: Limit number of results - name: mode in: query required: false schema: $ref: '#/components/schemas/ListMode' description: 1=Hypothesis, 2=Value Prop, 3=All default: 3 description: 1=Hypothesis, 2=Value Prop, 3=All responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/search: post: tags: - search summary: Search Value Propositions description: 'Search value propositions accessible to the authenticated user. Supports text search on VP name and company name, sorting, and pagination.' operationId: search_value_propositions_v1_value_proposition_search_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchRequest' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/companies/admin-validate: post: tags: - companies summary: Validate a company description: "Admin-only: Validate or create company.\n- Reads sfdc_account_id and user_id from JSON body.\n- If feature\ \ 83 is OFF: create shared company (account_id=0).\n- If feature 83 is ON:\n * Try to find company by (account_id,\ \ account_defined_id = sfdc_account_id)\n * If found -> return its id\n * Else -> create company with (user's\ \ account_id, user_id, sfdc_account_id) and return id" operationId: admin_validate_company_v1_value_proposition_companies_admin_validate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/AdminValidatePayload' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] - HTTPBearer: [] /v1/value-proposition/companies/validate: post: tags: - companies summary: Validate a company description: Endpoint for validating a company operationId: validate_company_v1_value_proposition_companies_validate_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyValidatePayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CompanyValidateReturn' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/companies/search: post: tags: - companies summary: Search for a company description: "Endpoint for searching companies database\n\nParameters\n-------\npayload\n The SearchPayload needed\ \ to find company\n\nReturns\n-------\nList[Company]\n Returns the list of matching companies" operationId: search_companies_v1_value_proposition_companies_search_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SearchPayload' required: true responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Company' type: array title: Response Search Companies V1 Value Proposition Companies Search Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/companies: post: tags: - companies summary: Create a company new company description: "Endpoint for creating a new company\n\nParameters\n-------\npayload\n The CompanyPayload needed to\ \ create the company\n\nReturns\n-------\nCompany\n Returns the company, if created. Returns 409 if company exists" operationId: create_company_v1_value_proposition_companies_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCompanyPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Company' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/workflows: get: tags: - workflows summary: Return the workflows available to the user description: "Endpoint for reading user workflows\n\nParameters\n-------\nincludeAll\n Include all account workflows\ \ or just the user's active workflows\n\nReturns\n-------\nList[Workflow]\n Returns the list of workflows" operationId: get_workflows_v1_value_proposition_workflows_get security: - HTTPBearer: [] parameters: - name: includeAll in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Includeall responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Workflow' title: Response Get Workflows V1 Value Proposition Workflows Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits/{benefitId}: get: tags: - benefits summary: Get the details for a single benefit description: "Endpoint for reading a single benefit's details\n\nReturns\n-------\nSingleBenefitDetail\n Returns\ \ the Benefit Details" operationId: get_single_benefit_v1_value_proposition__valuePropId__benefits__benefitId__get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: benefitId in: path required: true schema: type: integer title: Benefitid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/SingleBenefitDetail' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - benefits summary: Update benefit phasing and factors description: "Endpoint for updating benefit phasing and factors\n\nParameters\n----------\npayload : BenefitPhasingAndFactorPayload\n\ \ The payload containing phasing and factors updates\nrequest : Request\n The FastAPI request object\nvalue_prop_id\ \ : int\n The ID of the value proposition\nbenefit_id : int\n The ID of the benefit to update\n\nReturns\n-------\n\ JSONResponse\n Response with success message" operationId: update_benefit_phasing_v1_value_proposition__valuePropId__benefits__benefitId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: benefitId in: path required: true schema: type: integer title: Benefitid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BenefitPhasingAndFactorPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BenefitPhasingUpdateResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits: get: tags: - benefits summary: Get the Benefits for a Value Proposition by Value Category description: "Endpoint for reading Benefits for a Value Proposition grouped by the\nrequested dimension (default: value_category).\n\ \nReturns a dict with ``vcs`` and grouping availability flags.\n\nReturns\n-------\ndict\n Benefits response with\ \ vcs and grouping flags" operationId: get_benefits_v1_value_proposition__valuePropId__benefits_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: show_all in: query required: false schema: type: integer default: 1 title: Show All - name: summed_benefits in: query required: false schema: type: integer default: 0 title: Summed Benefits - name: order_flag in: query required: false schema: type: integer default: 0 title: Order Flag - name: filter_by in: query required: false schema: $ref: '#/components/schemas/FilterByOption' default: value_category responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ValueCategory' title: Response Get Benefits V1 Value Proposition Valuepropid Benefits Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits-active: patch: tags: - benefits summary: Save the Benefit Active statuses for benefits description: "Endpoint for saving Benefit Active statuses\n\nParameters\n----------\nbenefits : BenefitActivePayload\n\ \ The Benefits and their Active statuses\n\nReturns\n-------\nMessageResponse\n Returns success and message" operationId: update_benefit_active_status_v1_value_proposition__valuePropId__benefits_active_patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BenefitActivePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits-by-type: get: tags: - benefits summary: Returns the benefits by type(financial/non financial) description: 'Returns benefits grouped by type with configurable filtering and ordering.' operationId: get_benefit_by_type_v1_value_proposition__valuePropId__benefits_by_type_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: show_all in: query required: false schema: type: integer default: 1 title: Show All - name: summed_benefits in: query required: false schema: type: integer default: 1 title: Summed Benefits - name: order_flag in: query required: false schema: type: integer default: 0 title: Order Flag - name: filter_by in: query required: false schema: $ref: '#/components/schemas/FilterByOption' default: value_category - name: full_format in: query required: false schema: type: integer default: 0 title: Full Format - name: legacy_format in: query required: false schema: type: integer default: 0 title: Legacy Format responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/BenefitsByTypeResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefit-fields/{benefitId}: patch: tags: - benefits summary: Update benefit fields description: "Endpoint for updating benefit fields\n\nParameters\n----------\n- value_prop_id\n- benefit_id\n- payload\ \ : BenefitFieldsPayload\n The fields to update\n\nReturns\n-------\nMessageResponse\n Returns success and message" operationId: update_benefit_fields_endpoint_v1_value_proposition__valuePropId__benefit_fields__benefitId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: benefitId in: path required: true schema: type: integer title: Benefitid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BenefitFieldsPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits/calculate: post: tags: - benefits-calculate summary: Recalculate all benefits with phasing description: Trigger a full benefit recalculation for a value prop. operationId: calculate_benefits_v1_value_proposition__valuePropId__benefits_calculate_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits/one-time: post: tags: - benefits-one-time summary: Create a one-time (on-the-fly) benefit description: 'Create a new one-time benefit for a value proposition. Inserts rows into account_solution_metrics (vp_specific=1) and value_prop_metrics (active=1), inserts optional link rows, writes an audit log entry, and triggers inline benefit recalculation. Requires privilege_id=6 (Benefit on the Fly).' operationId: create_one_time_benefit_endpoint_v1_value_proposition__valuePropId__benefits_one_time_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OneTimeBenefitCreate' responses: '201': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/OneTimeBenefitResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/benefits/one-time/{benefitId}: patch: tags: - benefits-one-time summary: Partially update a one-time benefit description: 'Partially update a one-time benefit. Only updates fields present in the request payload. Validates ownership and one-time status via verify_one_time_benefit. Writes an audit log entry and triggers inline benefit recalculation.' operationId: update_one_time_benefit_endpoint_v1_value_proposition__valuePropId__benefits_one_time__benefitId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: benefitId in: path required: true schema: type: integer title: Benefitid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OneTimeBenefitPatch' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/all-factors: get: tags: - factors summary: Get all factors for a Value Proposition operationId: get_all_factors_route_v1_value_proposition__valuePropId__all_factors_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: ai_updatable_only in: query required: false schema: type: boolean default: false title: Ai Updatable Only responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AllFactor' title: Response Get All Factors Route V1 Value Proposition Valuepropid All Factors Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/key-factors: get: tags: - factors summary: Get the Key Factors by Factor Group description: "Endpoint for reading Key Factors by Factor group\n\nReturns\n-------\nList[FactorGroup]\n Returns the\ \ Factors organized by Factor Group" operationId: get_key_factors_v1_value_proposition__valuePropId__key_factors_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: ai_updatable_only in: query required: false schema: type: boolean default: false title: Ai Updatable Only responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/FactorGroup' title: Response Get Key Factors V1 Value Proposition Valuepropid Key Factors Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/scalers: get: tags: - factors summary: Get the scaling factors of Value Proposition description: "Endpoint for reading the Value Proposition scalers\n\nReturns\n-------\nList[Factor]\n Returns the\ \ Value Proposition scalers" operationId: get_scalers_v1_value_proposition__valuePropId__scalers_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: ai_updatable_only in: query required: false schema: type: boolean default: false title: Ai Updatable Only responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Factor' title: Response Get Scalers V1 Value Proposition Valuepropid Scalers Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/factors: patch: tags: - factors summary: Save the values for factors description: "Endpoint for saving Factors\n\nParameters\n----------\nfactors : FactorPayload\n The Factors and their\ \ values\n\nReturns\n-------\nMessageResponse\n Returns status code and success message" operationId: update_factors_v1_value_proposition__valuePropId__factors_patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FactorPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/factor-override: post: tags: - factors summary: override factor name description: "Endpoint for overriding factors\n\nParameters\n----------\nfactor_override : FactorOverrideNamePayload\n\ \ The factor override name and id\n\nReturns\n-------\nMessageResponse\n Returns status code and success message" operationId: override_factor_name_v1_value_proposition__valuePropId__factor_override_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FactorOverrideNamePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/situations: get: tags: - situations summary: Get the situations of Value Proposition description: "Endpoint for reading the Value Proposition situations\n\nReturns\n-------\nList[Situation]\n Returns\ \ the Value Proposition situations" operationId: get_situations_v1_value_proposition__valuePropId__situations_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: ai_updatable_only in: query required: false schema: type: boolean default: false title: Ai Updatable Only responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Situation' title: Response Get Situations V1 Value Proposition Valuepropid Situations Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - situations summary: Save the values for situations description: "Endpoint for saving situations\n\nParameters\n----------\nrequest\nvalue_prop_id\nsituations : SituationPayload\n\ \ The situations and their elements to be saved\n\nReturns\n-------\nMessageResponse\n Returns status code and\ \ success message" operationId: update_situations_v1_value_proposition__valuePropId__situations_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SituationPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/solutions: post: tags: - solutions summary: Post selected solutions description: 'Passthrough endpoint to submit the selected solutions. This endpoint forwards the selection to the Concierge API.' operationId: select_solutions_v1_value_proposition__valuePropId__solutions_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SolutionSelection' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/value_proposition__solutions__models__Solution' title: Response Select Solutions V1 Value Proposition Valuepropid Solutions Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - solutions summary: Get the solutions for a Value Proposition description: Endpoint to return all the solutions for the value prop. operationId: get_solutions_v1_value_proposition__valuePropId__solutions_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/value_proposition__solutions__models__Solution' title: Response Get Solutions V1 Value Proposition Valuepropid Solutions Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/solution-categories: get: tags: - solutions summary: Get the solutions for a Value Proposition description: Retrieve all solution categories operationId: get_solution_categories_v1_value_proposition__valuePropId__solution_categories_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Category' title: Response Get Solution Categories V1 Value Proposition Valuepropid Solution Categories Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/available-solutions: get: tags: - solutions summary: Get available solutions description: 'Retrieve all available solutions for the current user. When grouped=True, returns solutions grouped by category. When grouped=False (default), returns a flat list of solutions.' operationId: get_available_solutions_v1_value_proposition_available_solutions_get security: - HTTPBearer: [] parameters: - name: grouped in: query required: false schema: type: boolean default: false title: Grouped responses: '200': description: Successful Response content: application/json: schema: anyOf: - type: array items: $ref: '#/components/schemas/Category' - type: array items: $ref: '#/components/schemas/CategorySolution' title: Response Get Available Solutions V1 Value Proposition Available Solutions Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/costs: get: tags: - costs summary: Get the costs of Value Proposition description: Endpoint for reading the saved costs of a value proposition. operationId: get_costs_v1_value_proposition__valuePropId__costs_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CostResponse' title: Response Get Costs V1 Value Proposition Valuepropid Costs Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - costs summary: Save the values for costs description: Create a cost for a value proposition and roll up its totals. operationId: store_cost_v1_value_proposition__valuePropId__costs_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CostCreate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/available-costs: get: tags: - costs summary: Get the available costs of Value Proposition description: Endpoint for reading the available (not yet added) costs of a VP. operationId: get_available_costs_v1_value_proposition__valuePropId__available_costs_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/AvailableCost' title: Response Get Available Costs V1 Value Proposition Valuepropid Available Costs Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/costs/{costId}: delete: tags: - costs summary: Delete a cost from the Value Proposition description: Delete a cost from a value proposition and roll up its totals. operationId: delete_cost_v1_value_proposition__valuePropId__costs__costId__delete security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: costId in: path required: true schema: type: integer title: Costid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - costs summary: Update a cost in the Value Proposition description: Update a cost of a value proposition and roll up its totals. operationId: update_cost_v1_value_proposition__valuePropId__costs__costId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: costId in: path required: true schema: type: integer title: Costid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CostCreate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/costs/{costId}/name: patch: tags: - costs summary: Update a cost name in the Value Proposition description: Endpoint to update the name of a cost operationId: update_cost_name_v1_value_proposition__valuePropId__costs__costId__name_patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: costId in: path required: true schema: type: integer title: Costid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CostNameUpdate' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/assets: get: tags: - assets summary: Get the assets for a Value Proposition description: "Parameters\n----------\n - value_prop_id: int - value proposition id\n - include_deleted_templates: bool\ \ - optional query param\n - account_workflow_id: int - optional query param\n - is_value_tracker: bool - optional\ \ query param\n\nReturns\n-------" operationId: get_assets_v1_value_proposition__valuePropId__assets_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: includeDeletedTemplates in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Includedeletedtemplates - name: accountWorkflowId in: query required: false schema: anyOf: - type: integer - type: 'null' title: Accountworkflowid - name: isValueTracker in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Isvaluetracker responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Asset' title: Response Get Assets V1 Value Proposition Valuepropid Assets Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/logs: get: tags: - logs summary: Get the logs for a Value Proposition description: Endpoint to return the logs for the value prop. operationId: get_solutions_v1_value_proposition__valuePropId__logs_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: userId in: query required: false schema: anyOf: - type: integer - type: 'null' title: Userid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/LogEntry' title: Response Get Solutions V1 Value Proposition Valuepropid Logs Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/advanced: get: tags: - advanced summary: Get the Value proposition advance details description: Endpoint for reading the Value Propositions advance details operationId: get_value_proposition_advance_v1_value_proposition__valuePropId__advanced_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValuePropAdvanced' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - advanced summary: Update the Value proposition advanced details description: This endpoint sends the update payload to the backend and returns the update response directly. operationId: update_value_prop_advanced_v1_value_proposition__valuePropId__advanced_put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ValuePropAdvancedPayload' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/baseline-types: get: tags: - baseline_types summary: Get the Value proposition advance details description: Endpoint for reading the Value Propositions baseline types and mark the selected baseline operationId: get_baseline_types_v1_value_proposition__valuePropId__baseline_types_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/asset-languages: get: tags: - asset_languages summary: Get the Value proposition asset language description: Endpoint for reading the Value Propositions asset languages and mark the selected asset language operationId: get_asset_languages_v1_value_proposition__valuePropId__asset_languages_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/available-terms: get: tags: - available_terms summary: Get the Value proposition available terms description: Endpoint for reading the Value Proposition available terms and mark the selected baseline operationId: get_available_terms_v1_value_proposition__valuePropId__available_terms_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/accrual-types: get: tags: - accrual_types summary: Get all accrual types. description: "Get all accrual types.\n\nReturns\n-------\n - list[AccrualType]: List of all accrual types." operationId: get_accrual_types_v1_value_proposition_accrual_types_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/AccrualType' type: array title: Response Get Accrual Types V1 Value Proposition Accrual Types Get security: - HTTPBearer: [] /v1/value-proposition/expense-types: get: tags: - expense_types summary: Get all expense types. description: "Get all expense types.\n\nReturns\n-------\n - list[ExpenseType]: List of all expense types." operationId: get_expense_types_v1_value_proposition_expense_types_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/ExpenseType' type: array title: Response Get Expense Types V1 Value Proposition Expense Types Get security: - HTTPBearer: [] /v1/value-proposition/cost-categories: get: tags: - cost_categories summary: Get all cost categories. description: "Get all cost categories.\n\nReturns\n-------\n - list[CostCategoryType]: List of all cost categories." operationId: get_cost_categories_v1_value_proposition_cost_categories_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/CostCategoryType' type: array title: Response Get Cost Categories V1 Value Proposition Cost Categories Get security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/driver-phasing: put: tags: - phasing summary: Update a Driver's Phasing description: "Endpoint for updating a driver's phasing\n\nParameters\n----------\npayload : UpdateDriverPhasingPayload\n\ \nReturns\n-------\nMessageResponse\n Returns the success message" operationId: update_driver_phasing_v1_value_proposition__valuePropId__driver_phasing_put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateDriverPhasingPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/scratchpads/{factorId}: get: tags: - scratchpads summary: Get scratchpad by factor description: "Endpoint for a factor's scratchpad\n\nParameters\n----------\nfactor_id : int\n The factor whose scratchpad\ \ is being requested\n\nReturns\n-------\nScratchpadResponse\n Returns the scratchpad and its units" operationId: get_scratchpad_v1_value_proposition__valuePropId__scratchpads__factorId__get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: factorId in: path required: true schema: type: integer title: Factorid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ScratchpadResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/scratchpads/total: post: tags: - scratchpads summary: Endpoint to calculate scratchpad total description: "Endpoint for getting scratchpad calculation total\n\nParameters\n----------\npayload : ScratchpadTotalPayload\n\ \ The pieces of the scratchpad to calculate\n\nReturns\n-------\nScratchpadTotalResponse\n Returns the scratchpad\ \ total" operationId: get_scratchpad_total_v1_value_proposition__valuePropId__scratchpads_total_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ScratchpadTotalPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ScratchpadTotalResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/roi-chart: get: tags: - roi summary: Get the ROI chart of a Value Proposition description: "Endpoint for reading the Value Proposition ROI chart\n\nReturns\n-------\nValuePropROIChart\n Returns\ \ the Value Proposition ROI chart" operationId: get_value_proposition_roi_chart_v1_value_proposition__valuePropId__roi_chart_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValuePropROIChart' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/features: get: tags: - features summary: Get the features by account id description: Endpoint for reading the feature by account id operationId: get_baseline_types_v1_value_proposition_features_get responses: '200': description: Successful Response content: application/json: schema: {} security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/done: patch: tags: - done summary: Set value prop done flags description: Endpoint for setting value prop done flags operationId: update_value_prop_done_v1_value_proposition__valuePropId__done_patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Done' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/groups/{valuePropGroupId}: delete: tags: - groups summary: Delete value prop group description: Endpoint for deleting a value prop group operationId: delete_value_prop_group_v1_value_proposition_groups__valuePropGroupId__delete security: - HTTPBearer: [] parameters: - name: valuePropGroupId in: path required: true schema: type: integer title: Valuepropgroupid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/groups-by-account: get: tags: - salesforce summary: Get value prop groups for account description: Endpoint for getting value prop groups for an account operationId: groups_by_account_v1_value_proposition_groups_by_account_get security: - HTTPBearer: [] parameters: - name: account_defined_id in: query required: true schema: type: string title: Account Defined Id - name: company_id in: query required: false schema: anyOf: - type: integer - type: string - type: 'null' title: Company Id - name: opportunity_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Opportunity Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FormattedResponse_VPGroupResult_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/value-props-by-account: get: tags: - salesforce summary: Get value props by account description: Endpoint for getting value props by account operationId: value_props_by_account_v1_value_proposition_value_props_by_account_get security: - HTTPBearer: [] parameters: - name: account_defined_id in: query required: true schema: type: string title: Account Defined Id - name: company_id in: query required: false schema: anyOf: - type: integer - type: string - type: 'null' title: Company Id - name: opportunity_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Opportunity Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FormattedResponse_ValuePropResult_' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/value-trackers-by-account: get: tags: - salesforce summary: Get value trackers by account description: Endpoint for getting value trackers by account operationId: value_trackers_by_account_v1_value_proposition_value_trackers_by_account_get security: - HTTPBearer: [] parameters: - name: account_defined_id in: query required: false schema: anyOf: - type: string - type: 'null' title: Account Defined Id - name: company_id in: query required: false schema: anyOf: - type: integer - type: string - type: 'null' title: Company Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/FormattedResponse_list_ExternalTracker__' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/refresh/group: put: tags: - refresh summary: Refresh value prop group description: "Endpoint for refreshing value prop group\n\nReturns\n-------\nJSONResponse\n - On success (HTTP 200):\n\ \ {\n \"data\": [ ]\n }\n - On failure (HTTP 500): returns\n {\n \ \ \"message\": \"Unable to refresh value prop group\"\n }" operationId: refresh_value_prop_group_v1_value_proposition_refresh_group_put requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshValuePropGroupPayload' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/refresh: put: tags: - refresh summary: Refresh value prop description: "Endpoint for refreshing value prop\n\nReturns\n-------\nJSONResponse\n - On success (HTTP 200): returns\n\ \ {\n \"data\": [ ]\n }\n - On failure (HTTP 500): returns\n {\n \ \ \"message\": \"Unable to refresh value prop\"\n }" operationId: refresh_value_prop_v1_value_proposition_refresh_put requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshValuePropPayload' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/refresh/tracker: put: tags: - refresh summary: Refresh value tracker description: "Endpoint for refreshing value tracker\n\nReturns\n-------\nJSONResponse\n - On success (200): a list\ \ of objects each containing a\n `result` with:\n • `success`: bool\n • `data`: dict of tracker\ \ fields (e.g. name, benefits, timestamps)\n • `value_prop_id`, `sfdc_vt_id`, etc.\n - On failure (500):\ \ `{\"message\": \"Unable to refresh value tracker\"}`" operationId: refresh_value_tracker_v1_value_proposition_refresh_tracker_put requestBody: content: application/json: schema: $ref: '#/components/schemas/RefreshValueTrackerPayload' required: true responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/refresh/bulk: put: tags: - refresh summary: Refresh value prop in bulk description: "Refresh all value propositions in bulk.\n-------\nJSONResponse\n - On success (200): a list of status\ \ objects, for example:\n [{\"result\": \"Bulk upload process started\"}]\n - On failure (500):\n \ \ {\"message\": \"Unable to refresh value prop in bulk\"}" operationId: refresh_value_prop_bulk_v1_value_proposition_refresh_bulk_put responses: '200': description: Successful Response content: application/json: schema: {} security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/scorecard: get: tags: - scorecard summary: Get value proposition scorecard with threshold evaluations description: "Get scorecard for a value proposition\n\nThis endpoint evaluates the value proposition against configured\ \ thresholds\nand returns a traffic light status system (red/yellow/green) for each\nthreshold type, along with override\ \ metrics and phasing information.\n\nParameters\n----------\nvalue_prop_id : int\n The ID of the value proposition\ \ to evaluate\n\nReturns\n-------\nScorecardResponse\n Complete scorecard with threshold evaluations, status, and\ \ metrics\n\nRaises\n------\nHTTPException\n 404 if value proposition not found\n 500 if calculation fails" operationId: get_value_proposition_scorecard_v1_value_proposition__valuePropId__scorecard_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ScorecardResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/goals: get: tags: - goals summary: Read goals description: "Retrieve all value realization goals for a given Value Proposition.\n\nThis endpoint fetches every goal\ \ associated with the specified\n`value_prop_id` from the database. If no goals exist, it returns\nan empty list.\n\ \nArgs:\n value_prop_id (int): The unique ID of the Value Proposition\n whose goals should be returned.\n\ \nReturns:\n List[ValueRealizationGoal]: A list of fully populated\n `ValueRealizationGoal` models, encoded\ \ as JSON.\n\nRaises:\n HTTPException: On any database error; will be caught and\n re-reported as a 500\ \ with an error message." operationId: get_goals_v1_value_proposition__valuePropId__goals_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ValueRealizationGoal' title: Response Get Goals V1 Value Proposition Valuepropid Goals Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' put: tags: - goals summary: Update goals description: "Bulk-update baseline, target, and active flags for multiple goals.\n\nAccepts a list of goal updates—each\ \ containing an `id`, and any\ncombination of `baseline_value`, `value` (target), and `active`.\nMissing numeric fields\ \ will default to 0 on update. After applying\nall updates, it re-queries the database and returns the fresh list\n\ of goals.\n\nArgs:\n goals (List[ValueRealizationGoalUpdate]):\n A list of updates, where each element includes:\n\ \ - `id` (int): the goal’s primary key\n - `baseline_value` (float): new baseline (defaults to 0)\n\ \ - `value` (float): new target value (defaults to 0)\n - `active` (int): active flag, 0 or 1 (defaults\ \ to 0)\n value_prop_id (int): The Value Proposition ID under which\n these goals are defined.\n\nReturns:\n\ \ List[ValueRealizationGoal]: The updated full goal records,\n each as a `ValueRealizationGoal` model, encoded\ \ as JSON. If\n no goals remain, returns an empty list.\n\nRaises:\n HTTPException: If any individual update\ \ or the final read\n fails; re-reported as HTTP 500 with a JSON error payload." operationId: update_goals_v1_value_proposition__valuePropId__goals_put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: type: array items: $ref: '#/components/schemas/ValueRealizationGoalUpdate' title: Goals responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ValueRealizationGoal' title: Response Update Goals V1 Value Proposition Valuepropid Goals Put '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/goal-groups: get: tags: - goals summary: Read goal groups description: "Retrieve all value realization goals for a given Value Proposition\ngrouped by goal group\n\nArgs:\n \ \ value_prop_id (int): The unique ID of the Value Proposition\n whose goals should be returned.\n\nReturns:\n\ \ List[ValueRealizationGoalGroup]: A list of fully populated\n `ValueRealizationGoalGroup` models, encoded as\ \ JSON.\n\nRaises:\n HTTPException: On any database error; will be caught and\n re-reported as a 500 with\ \ an error message." operationId: get_goal_groups_v1_value_proposition__valuePropId__goal_groups_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/ValueRealizationGoalGroup' title: Response Get Goal Groups V1 Value Proposition Valuepropid Goal Groups Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/discovery-questions: get: tags: - discovery_questions summary: Read value proposition discovery questions description: "Parameters\n----------\nsection_type_id : int (Optional)\n If sent, will only return discovery questions\ \ for this section\nai_updatable_only : bool (Optional)\n If true, only return discovery questions that are AI\ \ updatable\n\nReturns\n-------\nList[DiscoveryQuestion]\n The list of discovery questions" operationId: get_discovery_questions_v1_value_proposition__valuePropId__discovery_questions_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: sectionTypeId in: query required: false schema: anyOf: - type: integer - type: 'null' title: Sectiontypeid - name: ai_updatable_only in: query required: false schema: type: boolean default: false title: Ai Updatable Only responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DiscoveryQuestion' title: Response Get Discovery Questions V1 Value Proposition Valuepropid Discovery Questions Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - discovery_questions summary: Update discovery question answers description: "Update answers to discovery questions\n\nParameters\n----------\npayload : DiscoveryAnswerPayload\n \ \ List of answers to discovery questions\n\nReturns\n-------\nList[DiscoveryQuestion]\n The list of discovery\ \ questions" operationId: update_discovery_questions_v1_value_proposition__valuePropId__discovery_questions_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DiscoveryAnswerPayload' responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/DiscoveryQuestion' title: Response Update Discovery Questions V1 Value Proposition Valuepropid Discovery Questions Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/shares: get: tags: - shares summary: List of people who have a share on the value prop description: Endpoint to return a list of people who have a share on a value prop operationId: get_value_prop_shares_v1_value_proposition__valuePropId__shares_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Shares' title: Response Get Value Prop Shares V1 Value Proposition Valuepropid Shares Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - shares summary: Create new share for the user description: Endpoint to create value prop share for user operationId: create_value_prop_share_v1_value_proposition__valuePropId__shares_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateShare' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/shares/{shareId}: delete: tags: - shares summary: Delete the sharedId from value prop description: Endpoint to delete a share from a value prop operationId: delete_value_prop_share_v1_value_proposition__valuePropId__shares__shareId__delete security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: shareId in: path required: true schema: type: integer title: Shareid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - shares summary: Update value prop share description: Endpoint to update share_role_type_id for a value prop share operationId: update_value_prop_share_v1_value_proposition__valuePropId__shares__shareId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: shareId in: path required: true schema: type: integer title: Shareid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateShare' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/collaborations: get: tags: - collaborations summary: Read customer collaboration shares description: Fetch and return all collaboration shares for the given value proposition. operationId: get_collaborations_v1_value_proposition__valuePropId__collaborations_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/CollaborationShare' title: Response Get Collaborations V1 Value Proposition Valuepropid Collaborations Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - collaborations summary: Create collaboration shares description: Endpoint to create collaboration shares for value prop operationId: create_collaboration_share_v1_value_proposition__valuePropId__collaborations_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCollaboration' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CreateCollaborationResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/collaborations/{collaborationId}: put: tags: - collaborations summary: Update customer collaboration share description: Endpoint to update a collaboration share operationId: update_customer_collaboration_v1_value_proposition__valuePropId__collaborations__collaborationId__put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: collaborationId in: path required: true schema: type: integer title: Collaborationid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCollaboration' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - collaborations summary: Delete customer collaboration share description: Endpoint to delete a collaboration share operationId: delete_customer_collaboration_v1_value_proposition__valuePropId__collaborations__collaborationId__delete security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: collaborationId in: path required: true schema: type: integer title: Collaborationid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/products: get: tags: - products summary: List active products by account description: Endpoint to list active products by account operationId: get_products_v1_value_proposition_products_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Product' type: array title: Response Get Products V1 Value Proposition Products Get security: - HTTPBearer: [] /v1/value-proposition/privileges: get: tags: - privileges summary: List user privileges description: Endpoint to list user privileges operationId: get_user_privileges_v1_value_proposition_privileges_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/Privilege' type: array title: Response Get User Privileges V1 Value Proposition Privileges Get security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/grouping-override: put: tags: - grouping_override summary: Update value proposition grouping override description: Endpoint for updating value proposition grouping override operationId: update_value_proposition_grouping_override_v1_value_proposition__valuePropId__grouping_override_put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GroupingOverridePayload' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/users: get: tags: - users summary: Get all users for the account of the requesting user description: Endpoint for reading all users for the account of the requesting user operationId: get_users_v1_value_proposition_users_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/User' type: array title: Response Get Users V1 Value Proposition Users Get security: - HTTPBearer: [] /v1/value-proposition/me: get: tags: - users summary: Get the authenticated user info description: Endpoint for reading basic info of the currently authenticated user operationId: get_current_user_v1_value_proposition_me_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CurrentUser' security: - HTTPBearer: [] /v1/value-proposition/dynamic-discovery/account-solutions: get: tags: - dynamic_discovery summary: Read account solutions for an account description: 'Endpoint to read account solutions for dynamic discovery selection Returns ------- The list of solutions' operationId: get_dynamic_discovery_account_solutions_v1_value_proposition_dynamic_discovery_account_solutions_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/value_proposition__dynamic_discovery__models__Solution' type: array title: Response Get Dynamic Discovery Account Solutions V1 Value Proposition Dynamic Discovery Account Solutions Get security: - HTTPBearer: [] post: tags: - dynamic_discovery summary: Save default solutions for dynamic discovery description: 'Endpoint to save account default solutions for dynamic discovery Returns ------- The list of solutions' operationId: create_dynamic_discovery_account_solutions_v1_value_proposition_dynamic_discovery_account_solutions_post requestBody: content: application/json: schema: $ref: '#/components/schemas/SolutionsPayload' required: true responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/value_proposition__dynamic_discovery__models__Solution' type: array title: Response Create Dynamic Discovery Account Solutions V1 Value Proposition Dynamic Discovery Account Solutions Post '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/dynamic-discovery/selected-solutions: get: tags: - dynamic_discovery summary: Read default solutions for dynamic discovery description: 'Endpoint to read account default solutions for dynamic discovery Returns ------- The list of solutions' operationId: get_selected_dynamic_discovery_account_solutions_v1_value_proposition_dynamic_discovery_selected_solutions_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/value_proposition__dynamic_discovery__models__Solution' type: array title: Response Get Selected Dynamic Discovery Account Solutions V1 Value Proposition Dynamic Discovery Selected Solutions Get security: - HTTPBearer: [] /v1/value-proposition/dynamic-discovery: get: tags: - dynamic_discovery summary: Determine if a user has Dynamic Discovery privilege description: 'Endpoint to determine if a user has dynamic discovery privilege Requires -------- Admin privilege from user hitting endpoint Returns ------- DynamicDiscoveryResponse determining if user has privilege' operationId: get_dynamic_discovery_privilege_v1_value_proposition_dynamic_discovery_get security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: email in: query required: true schema: type: string title: Email responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/DynamicDiscoveryResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/dynamic-discovery/trigger-settings: get: tags: - dynamic_discovery summary: Read opportunity stage/type trigger settings description: 'Endpoint to read which Salesforce opportunity stages and types trigger VP auto-generation Returns ------- TriggerSettingsResponse with the configured trigger stages and types' operationId: get_trigger_settings_v1_value_proposition_dynamic_discovery_trigger_settings_get responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TriggerSettingsResponse' security: - HTTPBearer: [] put: tags: - dynamic_discovery summary: Update opportunity stage/type trigger settings description: 'Endpoint to set which Salesforce opportunity stages and types trigger VP auto-generation. Empty lists mean VP is triggered on any opportunity creation (default behavior). Returns ------- TriggerSettingsResponse with the updated trigger stages and types' operationId: update_trigger_settings_v1_value_proposition_dynamic_discovery_trigger_settings_put requestBody: content: application/json: schema: $ref: '#/components/schemas/TriggerSettingsPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/TriggerSettingsResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/format-types: get: tags: - format_types summary: Get all format types. description: "Get all format types.\n\nReturns\n-------\n - list[FormatType]: List of all format types." operationId: get_format_types_v1_value_proposition_format_types_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/FormatType' type: array title: Response Get Format Types V1 Value Proposition Format Types Get security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/collateral: get: tags: - collateral summary: Read collateral description: 'Retrieve all collateral records for a given value proposition. Path Parameters: - valuePropId (int): Identifier of the value proposition whose collateral items to fetch.' operationId: get_collaterals_v1_value_proposition__valuePropId__collateral_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Collateral' title: Response Get Collaterals V1 Value Proposition Valuepropid Collateral Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' post: tags: - collateral summary: Add collateral description: "Create a new collateral item under a given value proposition.\n\nPath Parameters:\n- valuePropId (int):\ \ Identifier of the value proposition to which this collateral belongs.\n\nBody:\n- CollateralCreatePayload: {\n \ \ \"format_type_id\": \"1\",\n \"name\": \"test12334\",\n \"description\": \"test\",\n \"url\": \"test123.com\"\ \n}" operationId: add_collateral_v1_value_proposition__valuePropId__collateral_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CollateralCreatePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/collateral/{collateralId}: put: tags: - collateral summary: Update collateral description: "Update an existing collateral record.\n\nPath Parameters:\n- valuePropId (int): Identifier of the parent\ \ value proposition.\n- collateralId (int): Identifier of the collateral to update.\n\nBody:\n- CollateralUpdatePayload:\n\ {\n \"format_type_id\": \"1\",\n \"name\": \"test12334\",\n \"description\": \"test\",\n \"url\": \"test123.com\"\ \n}" operationId: update_collateral_v1_value_proposition__valuePropId__collateral__collateralId__put security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: collateralId in: path required: true schema: type: integer title: Collateralid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CollateralUpdatePayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - collateral summary: Delete collateral description: 'Delete a collateral record. Path Parameters: - valuePropId (int): Identifier of the value proposition. - collateralId (int): Identifier of the collateral to delete.' operationId: delete_collateral_v1_value_proposition__valuePropId__collateral__collateralId__delete security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: collateralId in: path required: true schema: type: integer title: Collateralid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/attributions: post: tags: - attributions summary: Save new value prop attributions description: Endpoint to create value prop attributions operationId: save_value_prop_attributions_v1_value_proposition__valuePropId__attributions_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAttribution' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' get: tags: - attributions summary: Read attributions for VP description: Endpoint to get attributions operationId: read_attributions_v1_value_proposition__valuePropId__attributions_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid - name: sectionTypeId in: query required: false schema: anyOf: - type: integer - type: 'null' title: Sectiontypeid - name: objectId in: query required: false schema: anyOf: - type: integer - type: 'null' title: Objectid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/source-types: get: tags: - source_types summary: Get source types. description: "Get source types.\n\nParameters\n----------\ndisplayOnly: Optional[boolean]\n Only return display options.\ \ Defaults to False\n\nReturns\n-------\n - list[SourceType]: List of source types." operationId: get_source_types_v1_value_proposition_source_types_get security: - HTTPBearer: [] parameters: - name: displayOnly in: query required: false schema: anyOf: - type: boolean - type: 'null' default: false title: Displayonly responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/value_proposition__facts__source_types__source_type__SourceType' title: Response Get Source Types V1 Value Proposition Source Types Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/translations: get: tags: - translations summary: Get all translations. description: Return translations joined with the components catalog. operationId: get_translations_v1_value_proposition_translations_get security: - HTTPBearer: [] parameters: - name: version in: query required: false schema: type: integer description: Translations components version (default 2). default: 2 title: Version description: Translations components version (default 2). responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/Translation' title: Response Get Translations V1 Value Proposition Translations Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/translations/components: get: tags: - translations summary: Get all translation components. description: Return every row from translations_components. operationId: get_translation_components_v1_value_proposition_translations_components_get security: - HTTPBearer: [] parameters: - name: version in: query required: false schema: type: integer description: Translations components version (default 2). default: 2 title: Version description: Translations components version (default 2). responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TranslationComponent' title: Response Get Translation Components V1 Value Proposition Translations Components Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/translations/by-component: get: tags: - translations summary: Get translations for a component and language with account overrides applied. description: 'Return translations for the given component and language, merging the authenticated account''s overrides on top of the base translations.' operationId: get_translations_with_overrides_v1_value_proposition_translations_by_component_get security: - HTTPBearer: [] parameters: - name: component in: query required: true schema: type: string description: Translations component. title: Component description: Translations component. - name: lang in: query required: true schema: type: string description: Language code (e.g. 'en'). title: Lang description: Language code (e.g. 'en'). - name: version in: query required: false schema: type: integer description: Translations components version (default 2). default: 2 title: Version description: Translations components version (default 2). responses: '200': description: Successful Response content: application/json: schema: type: array items: $ref: '#/components/schemas/TranslationWithOverride' title: Response Get Translations With Overrides V1 Value Proposition Translations By Component Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/account-factors: get: tags: - account_factors summary: Get account factors description: 'Endpoint to get account factors Returns ------- The list of account factors' operationId: get_account_factors_v1_value_proposition_account_factors_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/AccountFactor' type: array title: Response Get Account Factors V1 Value Proposition Account Factors Get security: - HTTPBearer: [] /v1/value-proposition/account-mappings: get: tags: - account_mappings summary: Get account mappings description: 'Endpoint to get account mappings Returns ------- The list of account factors' operationId: get_account_mappings_v1_value_proposition_account_mappings_get responses: '200': description: Successful Response content: application/json: schema: items: $ref: '#/components/schemas/MappingResponse' type: array title: Response Get Account Mappings V1 Value Proposition Account Mappings Get security: - HTTPBearer: [] post: tags: - account_mappings summary: Create account mapping description: "Endpoint to create a new account mapping.\nIf a mapping exists for the same account_id, value_object_type,\n\ and value_object_id, it will return an error.\n\nParameters\n----------\nmapping : Mapping\n Mapping to create\n\ \nReturns\n-------\nJSONResponse with success message" operationId: create_account_mapping_v1_value_proposition_account_mappings_post requestBody: content: application/json: schema: $ref: '#/components/schemas/Mapping' required: true responses: '201': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/account-mappings/{mapping_id}: delete: tags: - account_mappings summary: Delete account mapping description: "Endpoint to delete an account mapping by ID.\nFirst verifies that the mapping exists and belongs to the\ \ user's account.\n\nParameters\n----------\nmapping_id : int\n ID of the mapping to delete\n\nReturns\n-------\n\ JSONResponse with success message" operationId: delete_account_mapping_v1_value_proposition_account_mappings__mapping_id__delete security: - HTTPBearer: [] parameters: - name: mapping_id in: path required: true schema: type: integer title: Mapping Id responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - account_mappings summary: Update account mapping description: "Endpoint to update an account mapping by ID.\nChecks that the user has account admin privileges,\nthat\ \ the user's account_id matches the mapping's account_id,\nand that no other mapping exists with the same value_object_type\n\ and value_object_id for the account.\n\nParameters\n----------\nmapping_id : int\n ID of the mapping to update\n\ mapping : Mapping\n Mapping data to update\n\nReturns\n-------\nJSONResponse with success message" operationId: update_account_mapping_v1_value_proposition_account_mappings__mapping_id__patch security: - HTTPBearer: [] parameters: - name: mapping_id in: path required: true schema: type: integer title: Mapping Id requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Mapping' responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/cost-of-delay: get: tags: - charts summary: Get the cost of delay of a Value Proposition description: Read cost of delay data for a value proposition. operationId: get_value_proposition_cost_of_delay_v1_value_proposition__valuePropId__cost_of_delay_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/CostOfDelay' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/payback-chart: get: tags: - charts summary: Get the payback chart of a Value Proposition description: Read payback chart data for a value proposition. operationId: get_value_proposition_payback_chart_v1_value_proposition__valuePropId__payback_chart_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/PaybackChart' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/calculate-metrics: post: tags: - value_props summary: Calculate metrics for a value proposition description: "Endpoint for calculating metrics for a value proposition\n\nParameters\n----------\nvalue_prop_id : int\n\ \ The value proposition ID\n\nReturns\n-------\nJSONResponse\n Returns the calculated metrics response" operationId: calculate_metrics_v1_value_proposition__valuePropId__calculate_metrics_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}: get: tags: - value_props summary: Get the details of a Value Proposition description: Endpoint for reading the Value Proposition details. operationId: get_value_proposition_v1_value_proposition__valuePropId__get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValueProp' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' patch: tags: - value_props summary: Update a Value Proposition description: "Endpoint for updating a value proposition\n\nParameters\n----------\npayload : UpdateValuePropPayload\n\ \nReturns\n-------\nMessageResponse\n Returns the success message" operationId: update_value_proposition_v1_value_proposition__valuePropId__patch security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateValuePropPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' delete: tags: - value_props summary: Delete a value proposition description: "Endpoint for deleting a Value Proposition\n\nReturns\n-------\nMessageResponse\n Response from delete\ \ action" operationId: delete_value_proposition_v1_value_proposition__valuePropId__delete security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/vc-chart: get: tags: - value_props summary: Get the vc chart of a Value Proposition description: "Endpoint for reading the Value Proposition vc charts\n\nReturns\n-------\nValueProp\n Returns the Value\ \ Proposition vc chart" operationId: get_value_proposition_vc_chart_v1_value_proposition__valuePropId__vc_chart_get security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValuePropVCChart' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition: post: tags: - value_props summary: Create a new Value Proposition description: "Endpoint for creating a Value Proposition\n\nParameters\n----------\npayload : CreateValuePropPayload\n\ \ The initial details for creating the Value Proposition\n\nReturns\n-------\nValueProp\n Returns the Value\ \ Proposition details" operationId: create_value_proposition_v1_value_proposition_post requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateValuePropPayload' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValueProp' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] /v1/value-proposition/{valuePropId}/clone: post: tags: - value_props summary: Create a Value Proposition clone description: "Endpoint for creating a value proposition clone\n\nParameters\n----------\npayload : CloneValuePropPayload\n\ \nReturns\n-------\nValueProp\n Returns the Value Proposition clone details" operationId: clone_value_proposition_v1_value_proposition__valuePropId__clone_post security: - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CloneValuePropPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ValueProp' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' /v1/value-proposition/{valuePropId}/reassign: patch: tags: - value_props summary: Reassign a Value Proposition description: Endpoint for reassigning a value proposition operationId: reassign_value_proposition_v1_value_proposition__valuePropId__reassign_patch security: - HTTPBearer: [] - HTTPBearer: [] parameters: - name: valuePropId in: path required: true schema: type: integer title: Valuepropid requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReassignValuePropPayload' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MessageResponse' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' components: schemas: AccountFactor: properties: id: type: integer title: Id description: Unique identifier for the factor account_id: type: integer title: Account Id description: ID of the account associated with the factor name: type: string title: Name description: Name of the factor description: anyOf: - type: string - type: 'null' title: Description description: Description for the factor sequence: type: integer title: Sequence description: Sequence for the factor type: object required: - id - account_id - name - sequence title: AccountFactor description: AccountFactor model AccrualType: properties: id: type: integer title: Id description: Unique identifier for the accrual type. name: type: string title: Name description: Name of the accrual type. description: anyOf: - type: string - type: 'null' title: Description description: Description of the accrual type. created: anyOf: - type: string - type: 'null' title: Created description: Timestamp when the accrual type was created. modified: anyOf: - type: string - type: 'null' title: Modified description: Timestamp when the accrual type was last updated. type: object required: - id - name title: AccrualType description: Accrual Type model AdminValidatePayload: properties: sfdc_account_id: type: string title: Sfdc Account Id description: Salesforce account id. user_id: type: integer title: User Id description: User id. name: type: string title: Name type: object required: - sfdc_account_id - user_id - name title: AdminValidatePayload description: Validate Admin Payload Model AllFactor: properties: factor_id: type: integer title: Factor Id factor_estimate: anyOf: - type: number - type: integer title: Factor Estimate factor_precision: type: integer title: Factor Precision source_type_id: type: integer title: Source Type Id unit_type_id: type: integer title: Unit Type Id value: anyOf: - type: number - type: string title: Value name: type: string title: Name description: type: string title: Description ai_updatable: type: boolean title: Ai Updatable default: false year1_value: anyOf: - type: number - type: string - type: 'null' title: Year1 Value year1_source_type_id: anyOf: - type: integer - type: 'null' title: Year1 Source Type Id year2_value: anyOf: - type: number - type: string - type: 'null' title: Year2 Value year2_source_type_id: anyOf: - type: integer - type: 'null' title: Year2 Source Type Id year3_value: anyOf: - type: number - type: string - type: 'null' title: Year3 Value year3_source_type_id: anyOf: - type: integer - type: 'null' title: Year3 Source Type Id year4_value: anyOf: - type: number - type: string - type: 'null' title: Year4 Value year4_source_type_id: anyOf: - type: integer - type: 'null' title: Year4 Source Type Id year5_value: anyOf: - type: number - type: string - type: 'null' title: Year5 Value year5_source_type_id: anyOf: - type: integer - type: 'null' title: Year5 Source Type Id year6_value: anyOf: - type: number - type: string - type: 'null' title: Year6 Value year6_source_type_id: anyOf: - type: integer - type: 'null' title: Year6 Source Type Id year7_value: anyOf: - type: number - type: string - type: 'null' title: Year7 Value year7_source_type_id: anyOf: - type: integer - type: 'null' title: Year7 Source Type Id year8_value: anyOf: - type: number - type: string - type: 'null' title: Year8 Value year8_source_type_id: anyOf: - type: integer - type: 'null' title: Year8 Source Type Id year9_value: anyOf: - type: number - type: string - type: 'null' title: Year9 Value year9_source_type_id: anyOf: - type: integer - type: 'null' title: Year9 Source Type Id year10_value: anyOf: - type: number - type: string - type: 'null' title: Year10 Value year10_source_type_id: anyOf: - type: integer - type: 'null' title: Year10 Source Type Id type: object required: - factor_id - factor_estimate - factor_precision - source_type_id - unit_type_id - value - name - description title: AllFactor description: All-factors response model — one entry per unique factor Asset: properties: sit_active: anyOf: - type: boolean - type: 'null' title: Sit Active id: type: integer title: Id description: Unique identifier for the asset account_id: type: integer title: Account Id description: ID of the account associated with the asset account_asset_id: type: integer title: Account Asset Id description: ID of the asset within the account language_type_id: type: integer title: Language Type Id description: ID representing the language type of the asset account_solution_id: type: integer title: Account Solution Id description: ID representing the solution associated with the asset sequence: type: integer title: Sequence description: Sequence order of the asset name: type: string title: Name description: Name of the asset description: type: string title: Description description: Detailed description of the asset template_path: type: string title: Template Path description: File path for the asset template artifact_name: type: string title: Artifact Name description: Name of the artifact associated with the asset default_active: anyOf: - type: integer - type: 'null' title: Default Active web_calculator: type: integer title: Web Calculator description: asset has a web calculator integration (0 or 1) pdf: type: integer title: Pdf description: asset has a PDF version available (0 or 1) term: type: integer title: Term description: Term identifier associated with the asset system_generated: type: integer title: System Generated description: Indicates if the asset was system-generated (0 or 1) dep_account_asset_template_id: anyOf: - type: integer - type: 'null' title: Dep Account Asset Template Id account_asset_template_id: anyOf: - type: integer - type: 'null' title: Account Asset Template Id description: Template ID associated with the asset format_type_id: type: integer title: Format Type Id description: Format type identifier of the asset format: type: string title: Format description: Format description of the asset asset_sequence: type: integer title: Asset Sequence description: Asset sequence order in relation to others download_url: anyOf: - type: string - type: 'null' title: Download Url description: URL to download the asset default: '' type: object required: - id - account_id - account_asset_id - language_type_id - account_solution_id - sequence - name - description - template_path - artifact_name - web_calculator - pdf - term - system_generated - account_asset_template_id - format_type_id - format - asset_sequence title: Asset description: Asset model AvailableCost: properties: id: type: integer title: Id description: Unique identifier for the cost item. account_solution_id: anyOf: - type: integer - type: 'null' title: Account Solution Id description: Account solution ID. cost_category_type_id: anyOf: - type: integer - type: 'null' title: Cost Category Type Id description: Cost category type ID. expense_type_id: anyOf: - type: integer - type: 'null' title: Expense Type Id description: Expense type ID. driver_factor_id: anyOf: - type: integer - type: 'null' title: Driver Factor Id description: Driver factor ID. sequence: anyOf: - type: integer - type: 'null' title: Sequence description: Sequence order. name: type: string title: Name description: Name of the cost item. description: anyOf: - type: string - type: 'null' title: Description description: Description of the cost item. accrual_type_id: anyOf: - type: integer - type: 'null' title: Accrual Type Id description: Accrual type ID. situation_id: anyOf: - type: integer - type: 'null' title: Situation Id description: Situation ID. investment_situation_id: anyOf: - type: integer - type: 'null' title: Investment Situation Id description: Investment situation ID. cost_baseline_answer: anyOf: - type: number - type: 'null' title: Cost Baseline Answer description: Cost baseline answer. scale_type_id: anyOf: - type: integer - type: 'null' title: Scale Type Id description: Scale type ID. unit_scale_type_id: anyOf: - type: integer - type: 'null' title: Unit Scale Type Id description: Unit scale type ID. account_competitor_id: anyOf: - type: integer - type: 'null' title: Account Competitor Id description: Account competitor ID. cost_to_us: anyOf: - type: integer - type: 'null' title: Cost To Us description: Cost to us flag. default_include: anyOf: - type: integer - type: 'null' title: Default Include description: Default include flag. dep_cost_id: anyOf: - type: integer - type: 'null' title: Dep Cost Id description: Dependent cost ID. straight_scaling: anyOf: - type: integer - type: 'null' title: Straight Scaling description: Straight scaling flag. unit_straight_scaling: anyOf: - type: integer - type: 'null' title: Unit Straight Scaling description: Unit straight scaling flag. ratio: anyOf: - type: number - type: 'null' title: Ratio description: Ratio value. unit_ratio: anyOf: - type: number - type: 'null' title: Unit Ratio description: Unit ratio value. formula: anyOf: - type: string - type: 'null' title: Formula description: Formula. unit_formula: anyOf: - type: string - type: 'null' title: Unit Formula description: Unit formula. yr1_costs: anyOf: - type: number - type: 'null' title: Yr1 Costs description: Cost for year 1. yr2_costs: anyOf: - type: number - type: 'null' title: Yr2 Costs description: Cost for year 2. yr3_costs: anyOf: - type: number - type: 'null' title: Yr3 Costs description: Cost for year 3. yr4_costs: anyOf: - type: number - type: 'null' title: Yr4 Costs description: Cost for year 4. yr5_costs: anyOf: - type: number - type: 'null' title: Yr5 Costs description: Cost for year 5. yr6_costs: anyOf: - type: number - type: 'null' title: Yr6 Costs description: Cost for year 6. yr7_costs: anyOf: - type: number - type: 'null' title: Yr7 Costs description: Cost for year 7. yr8_costs: anyOf: - type: number - type: 'null' title: Yr8 Costs description: Cost for year 8. yr9_costs: anyOf: - type: number - type: 'null' title: Yr9 Costs description: Cost for year 9. yr10_costs: anyOf: - type: number - type: 'null' title: Yr10 Costs description: Cost for year 10. rate: anyOf: - type: number - type: 'null' title: Rate description: Rate value. present_value: anyOf: - type: number - type: 'null' title: Present Value description: Present value. lease_term: anyOf: - type: integer - type: 'null' title: Lease Term description: Lease term. residual_value: anyOf: - type: number - type: 'null' title: Residual Value description: Residual value. buyout_value: anyOf: - type: number - type: 'null' title: Buyout Value description: Buyout value. unit_cost_baseline_answer: anyOf: - type: number - type: 'null' title: Unit Cost Baseline Answer description: Unit cost baseline answer. scale_type: anyOf: - type: string - type: 'null' title: Scale Type description: Scale type label. company_field: anyOf: - type: string - type: 'null' title: Company Field description: Company field. unit_scale_type: anyOf: - type: string - type: 'null' title: Unit Scale Type description: Unit scale type label. unit_company_field: anyOf: - type: string - type: 'null' title: Unit Company Field description: Unit company field. already_added: anyOf: - type: boolean - type: 'null' title: Already Added description: Whether the cost is already added. quantity: anyOf: - type: number - type: 'null' title: Quantity description: Quantity. cost: anyOf: - type: number - type: 'null' title: Cost description: Cost value. discount: anyOf: - type: string - type: number - type: 'null' title: Discount description: Discount applied. grand_total: anyOf: - type: number - type: 'null' title: Grand Total description: Grand total. subtotal: anyOf: - type: number - type: 'null' title: Subtotal description: Subtotal. cost_category_type: $ref: '#/components/schemas/CostCategoryType' description: Details of the cost category type. expense_type: anyOf: - $ref: '#/components/schemas/ExpenseType' - type: 'null' description: Expense type if available. created_at: type: string title: Created At description: Creation timestamp. updated_at: type: string title: Updated At description: Last updated timestamp. type: object required: - id - name - cost_category_type - created_at - updated_at title: AvailableCost description: Available Cost model BenefitActive: properties: value_prop_metric_id: type: string title: Value Prop Metric Id description: The ID for the Benefit active: type: string title: Active description: The active status for the Benefit type: object required: - value_prop_metric_id - active title: BenefitActive description: BenefitActive model BenefitActivePayload: properties: benefits: items: $ref: '#/components/schemas/BenefitActive' type: array title: Benefits description: The list of Benefit Active statuses to save type: object required: - benefits title: BenefitActivePayload description: BenefitActivePayload model BenefitCategory: properties: id: type: string title: Id description: ID of the benefit category name: type: string title: Name description: Name of the benefit category description: type: string title: Description description: Description of the benefit category metrics: items: $ref: '#/components/schemas/value_proposition__value_props__models__Benefit' type: array title: Metrics description: List of benefit metrics within this category type: object required: - id - name - description - metrics title: BenefitCategory description: Represents a category grouping of benefits. BenefitFieldsPayload: properties: alt_metric_name: anyOf: - type: string - type: 'null' title: Alt Metric Name description: Alternative metric name alt_metric_description: anyOf: - type: string - type: 'null' title: Alt Metric Description description: Alternative metric description metric_note: anyOf: - type: string - type: 'null' title: Metric Note description: General note for the metric metric_note_2: anyOf: - type: string - type: 'null' title: Metric Note 2 description: Second metric note metric_note_3: anyOf: - type: string - type: 'null' title: Metric Note 3 description: Third metric note features: anyOf: - type: string - type: 'null' title: Features description: Features of the metric tco_name: anyOf: - type: string - type: 'null' title: Tco Name description: TCO Name type: object title: BenefitFieldsPayload description: Benefit Fields Payload model BenefitPhasingAndFactorPayload: properties: benefit_phasing: anyOf: - $ref: '#/components/schemas/BenefitPhasingValue' - type: 'null' description: containing metric_phase_0 through metric_phase_10 factors: anyOf: - items: $ref: '#/components/schemas/FactorValue' type: array - type: 'null' title: Factors description: The factors and values being saved apply_all: anyOf: - type: integer - type: 'null' title: Apply All description: 'Apply strategy: 0=single metric, 1=all metrics, 2=value category, 3=models, 4=accrual type' default: 0 type: object title: BenefitPhasingAndFactorPayload description: Payload for updating benefit phasing and factors BenefitPhasingUpdateResponse: properties: message: type: string title: Message description: Outcome of each requested update warning: anyOf: - type: string - type: 'null' title: Warning description: Set when the write succeeded but totals may be stale type: object required: - message title: BenefitPhasingUpdateResponse description: Response model for the benefit phasing and factors update BenefitPhasingValue: properties: metric_phase_0: anyOf: - type: number - type: 'null' title: Metric Phase 0 description: Metric phasing at year 0 metric_phase_1: anyOf: - type: number - type: 'null' title: Metric Phase 1 description: Metric phasing at year 1 metric_phase_2: anyOf: - type: number - type: 'null' title: Metric Phase 2 description: Metric phasing at year 2 metric_phase_3: anyOf: - type: number - type: 'null' title: Metric Phase 3 description: Metric phasing at year 3 metric_phase_4: anyOf: - type: number - type: 'null' title: Metric Phase 4 description: Metric phasing at year 4 metric_phase_5: anyOf: - type: number - type: 'null' title: Metric Phase 5 description: Metric phasing at year 5 metric_phase_6: anyOf: - type: number - type: 'null' title: Metric Phase 6 description: Metric phasing at year 6 metric_phase_7: anyOf: - type: number - type: 'null' title: Metric Phase 7 description: Metric phasing at year 7 metric_phase_8: anyOf: - type: number - type: 'null' title: Metric Phase 8 description: Metric phasing at year 8 metric_phase_9: anyOf: - type: number - type: 'null' title: Metric Phase 9 description: Metric phasing at year 9 metric_phase_10: anyOf: - type: number - type: 'null' title: Metric Phase 10 description: Metric phasing at year 10 type: object title: BenefitPhasingValue description: Benefit Phasing Value model BenefitType: properties: id: type: string title: Id description: ID for the Value Category name: type: string title: Name description: Name of the Value Category description: type: string title: Description description: Description of the Value Category active_count: type: integer title: Active Count soft_count: type: integer title: Soft Count na_count: type: integer title: Na Count top_vc_total: type: string title: Top Vc Total vcs: items: $ref: '#/components/schemas/ValueCategory' type: array title: Vcs description: Value Category with benefits type: object required: - id - name - description - vcs title: BenefitType description: BenefitType model BenefitsByTypeResponse: properties: has_pain_points: anyOf: - type: boolean - type: 'null' title: Has Pain Points description: Denotes whether the Value Prop has pain points default: false has_functional_objectives: anyOf: - type: boolean - type: 'null' title: Has Functional Objectives description: Denotes whether the Value Prop has functional objectives default: false has_capabilities: anyOf: - type: boolean - type: 'null' title: Has Capabilities description: Denotes whether the Value Prop has capabilities default: false has_operational_objectives: anyOf: - type: boolean - type: 'null' title: Has Operational Objectives description: Denotes whether the Value Prop has operational objectives default: false has_sequence: anyOf: - type: boolean - type: 'null' title: Has Sequence description: Denotes whether the Value Prop has sequenced metrics default: false benefit_types: items: $ref: '#/components/schemas/BenefitType' type: array title: Benefit Types description: The metrics grouped by benefit type type: object required: - benefit_types title: BenefitsByTypeResponse description: Benefits by Type Response Model Category: properties: category_id: type: integer title: Category Id description: Category ID category_name: type: string title: Category Name description: Category Name category_description: type: string title: Category Description description: Category Description solutions: items: $ref: '#/components/schemas/CategorySolution' type: array title: Solutions description: List of solutions under this category type: object required: - category_id - category_name - category_description - solutions title: Category description: Solution Categories CategorySolution: properties: account_solution_id: type: integer title: Account Solution Id description: Account Solution ID account_solution_name: type: string title: Account Solution Name description: Name of the solution account_solution_description: type: string title: Account Solution Description description: Account Solution Description selected: anyOf: - type: boolean - type: 'null' title: Selected description: Indicates if the solution is selected type: object required: - account_solution_id - account_solution_name - account_solution_description title: CategorySolution description: Solutions grouped by categories ChildElement: properties: id: type: string title: Id description: ID for the Child Element account_situation_type_id: type: string title: Account Situation Type Id description: Account Situation Type ID name: type: string title: Name description: Name of the Child Element description: anyOf: - type: string - type: 'null' title: Description description: Description of the Child Element box_label: type: string title: Box Label description: Box Label of the Child Element default: '' parent_id: type: string title: Parent Id description: Parent ID of the Child Element child_element_type_id: type: string title: Child Element Type Id description: Child Element Type ID created: type: string title: Created description: Date when the Child Element was created modified: type: string title: Modified description: Date when the Child Element was modified dep_element_id: type: string title: Dep Element Id description: Dependency Element ID dep_parent_id: type: string title: Dep Parent Id description: Dependency Parent ID situation_element_id: type: string title: Situation Element Id description: Situation Element ID value: type: string title: Value description: Value of the Child Element situation_type_id: type: string title: Situation Type Id description: Situation Type ID name_override: anyOf: - type: string - type: 'null' title: Name Override description: Name Override of the Child Element description_override: anyOf: - type: string - type: 'null' title: Description Override description: Description Override of the Child Element guided_default_active: anyOf: - type: string - type: integer title: Guided Default Active description: Guided Default Active status selected: type: boolean title: Selected description: Selected status of the Child Element children: anyOf: - items: $ref: '#/components/schemas/ChildElement' type: array - type: 'null' title: Children description: Children of the Child Element can_set_child_element: type: boolean title: Can Set Child Element description: Can Set Child Element status type: object required: - id - account_situation_type_id - name - parent_id - child_element_type_id - created - modified - dep_element_id - dep_parent_id - situation_element_id - value - situation_type_id - guided_default_active - selected - can_set_child_element title: ChildElement description: Child Element model CloneValuePropPayload: properties: company_id: anyOf: - type: integer - type: string - type: 'null' title: Company Id description: ID of the Company for the ValueProp opportunity_id: anyOf: - type: integer - type: 'null' title: Opportunity Id description: Opportunity ID name: type: string title: Name description: Name of the Value Proposition user_id: anyOf: - type: integer - type: 'null' title: User Id description: User id who is the owner of value proposition type: object required: - company_id title: CloneValuePropPayload description: CloneValuePropPayload model CollaborationShare: properties: id: type: integer title: Id description: Unique identifier for this collaboration share value_prop_id: type: integer title: Value Prop Id description: ID of the associated Value Proposition user_id: type: integer title: User Id description: ID of the user who received the share email: type: string title: Email description: Email address of the collaborating user first_name: type: string title: First Name description: First name of the collaborating user last_name: type: string title: Last Name description: Last name of the collaborating user value_prop_name: type: string title: Value Prop Name description: Name of the shared Value Proposition share_role: type: string title: Share Role description: Role granted (e.g. view, edit) to the user is_external: type: boolean title: Is External description: Whether the collaborator is outside the organization access_token: type: string title: Access Token description: JWT used to access the shared link password: type: string title: Password description: Password for the shared link link: type: string title: Link description: Fully-formed collaboration URL including token & code expires: type: string format: date-time title: Expires description: When the collaboration expires created: type: string format: date-time title: Created description: When the collaboration was created benefits_editable: type: integer title: Benefits Editable assumptions_editable: type: integer title: Assumptions Editable account_asset_template_id: anyOf: - type: integer - type: 'null' title: Account Asset Template Id default: 0 discovery_questions_enabled: type: integer title: Discovery Questions Enabled type: object required: - id - value_prop_id - user_id - email - first_name - last_name - value_prop_name - share_role - is_external - access_token - password - link - expires - created - benefits_editable - assumptions_editable - discovery_questions_enabled title: CollaborationShare description: Collaboration Model Collateral: properties: id: type: integer title: Id description: Unique identifier for the collateral account_solution_id: type: integer title: Account Solution Id description: Identifier for the associated account solution value_prop_id: type: integer title: Value Prop Id description: Identifier for the related value proposition format_type_id: type: integer title: Format Type Id description: Identifier for the format type name: type: string title: Name description: Name of the collateral description: type: string title: Description description: Detailed description of the collateral url: type: string title: Url description: URL to access the collateral format: type: string title: Format description: Format of the collateral (e.g., Website) type: object required: - id - account_solution_id - value_prop_id - format_type_id - name - description - url - format title: Collateral description: Detailed Collateral Model CollateralCreatePayload: properties: account_solution_id: type: integer title: Account Solution Id description: ID of the account_solution this asset belongs to format_type_id: type: integer title: Format Type Id description: Foreign key to fact_format_types name: type: string title: Name description: Human-readable name of the asset description: anyOf: - type: string - type: 'null' title: Description description: Detailed description of the asset default: '' url: type: string title: Url description: URL where this asset can be accessed value_prop_id: type: integer title: Value Prop Id description: Identifier for the related value proposition (defaults to 0) default: 0 type: object required: - account_solution_id - format_type_id - name - url title: CollateralCreatePayload description: Detailed Collateral Create Payload Model CollateralUpdatePayload: properties: format_type_id: type: integer title: Format Type Id description: Foreign key to fact_format_types name: type: string title: Name description: Name of the asset description: anyOf: - type: string - type: 'null' title: Description description: Detailed description of the asset default: '' url: type: string title: Url description: URL where this asset can be accessed value_prop_id: type: integer title: Value Prop Id description: Identifier for the related value proposition (defaults to 0) default: 0 type: object required: - format_type_id - name - url title: CollateralUpdatePayload description: Detailed Collateral Update Payload Model Company: properties: id: anyOf: - type: integer - type: 'null' title: Id description: ID of the Company default: 0 account_id: type: integer title: Account Id description: Account ID of the user who created the Company account_defined_id: anyOf: - type: string - type: 'null' title: Account Defined Id description: Account Specific ID of the Company default: '' user_id: type: integer title: User Id description: ID of the user who created the Company name: type: string title: Name description: Name of the Company synopsis: anyOf: - type: string - type: 'null' title: Synopsis description: Synopsis of the Company default: '' description: anyOf: - type: string - type: 'null' title: Description description: Description of the Company default: '' ticker: anyOf: - type: string - type: 'null' title: Ticker description: Ticker of the Company default: '' industry_id: anyOf: - type: integer - type: 'null' title: Industry Id description: Industry ID of the Company default: 0 location_type: anyOf: - type: string - type: 'null' title: Location Type description: Location Type of the Company default: '' url: anyOf: - type: string - type: 'null' title: Url description: URL for the webste of the Company default: '' logo_path: anyOf: - type: string - type: 'null' title: Logo Path description: Logo path for the logo of the Company default: '' phone: anyOf: - type: string - type: 'null' title: Phone description: Phone Number of the Company default: '' address1: type: string title: Address1 description: Address1 of the Company address2: anyOf: - type: string - type: 'null' title: Address2 description: Address2 of the Company default: '' city: type: string title: City description: City of the Company state: type: string title: State description: State of the Company zip: type: string title: Zip description: Zip of the Company country: type: string title: Country description: Country of the Company country_id: anyOf: - type: integer - type: 'null' title: Country Id description: Country ID of the Company default: 0 region_id: anyOf: - type: integer - type: 'null' title: Region Id description: Region ID of the Company default: 0 market_area: anyOf: - type: string - type: 'null' title: Market Area description: Market Area of the Company default: '' from_calculator: anyOf: - type: integer - type: 'null' title: From Calculator description: Denotes whether the company is from a calculator Value Proposition default: 0 revenue: anyOf: - type: number - type: 'null' title: Revenue description: Revenue of the Company (in millions) revenue_fmt: anyOf: - type: string - type: 'null' title: Revenue Fmt description: Revenue of the Company Formatted (in millions) employees: anyOf: - type: integer - type: 'null' title: Employees description: Employee Count of the Company employees_fmt: anyOf: - type: string - type: 'null' title: Employees Fmt description: Employee Count of the Company Formatted dl_sector_id: anyOf: - type: integer - type: 'null' title: Dl Sector Id description: DandB Sector ID of the Company dl_sector_name: anyOf: - type: string - type: 'null' title: Dl Sector Name description: DandB Sector name of the Company can_edit: anyOf: - type: boolean - type: 'null' title: Can Edit description: Denotes whether or not the user can edit this Company's info type: object required: - account_id - user_id - name - address1 - city - state - zip - country title: Company description: Company Model CompanyValidatePayload: properties: sf_account_id: type: string title: Sf Account Id description: Salesforce account id. type: object required: - sf_account_id title: CompanyValidatePayload description: Validate Company Payload Model CompanyValidateReturn: properties: success: type: boolean title: Success description: If the validate company was a success or not company_id: type: integer title: Company Id description: ID of the company acc_specific: type: boolean title: Acc Specific description: Tells whether the account has account specific companies type: object required: - success - company_id - acc_specific title: CompanyValidateReturn description: Validate Company Return Model ConversationMember: properties: account_workflow_id: type: integer title: Account Workflow Id description: The ID of the workflow the ConversationMember belongs to id: type: integer title: Id description: The ID of the ConversationMember account_workflow_section_id: type: integer title: Account Workflow Section Id description: The workflow section of the ConversationMember workflow_data_source_id: type: integer title: Workflow Data Source Id description: The source of data for the workflow member_id: type: integer title: Member Id description: The member ID for the ConversationMember name: type: string title: Name description: The name of the ConversationMember description: type: string title: Description description: The description of the ConversationMember default_member_id: anyOf: - type: integer - type: 'null' title: Default Member Id description: The default member's ID, if applicable is_default_member: anyOf: - type: boolean - type: 'null' title: Is Default Member description: A flag indicating whether the member is the default member in the ConversationMember default: false type: object required: - account_workflow_id - id - account_workflow_section_id - workflow_data_source_id - member_id - name - description title: ConversationMember description: ConversationMember Model CostCategoryType: properties: id: type: integer title: Id description: Unique identifier for the cost category type. name: type: string title: Name description: Name of the cost category type. description: anyOf: - type: string - type: 'null' title: Description description: Description of the cost category type. created: anyOf: - type: string - type: 'null' title: Created description: Creation timestamp. modified: anyOf: - type: string - type: 'null' title: Modified description: Last updated timestamp. type: object required: - id - name title: CostCategoryType description: Cost Category Type model CostCreate: properties: accrual_type_id: type: integer title: Accrual Type Id description: Accrual Type ID. cost_category_type_id: type: integer title: Cost Category Type Id description: Cost Category Type ID. cost_type_id: type: integer title: Cost Type Id description: Cost Type ID. expense_type_id: anyOf: - type: integer - type: 'null' title: Expense Type Id description: Expense Type ID. description: anyOf: - type: string - type: 'null' title: Description description: Description of the cost item. name: anyOf: - type: string maxLength: 255 - type: 'null' title: Name description: Name of the cost item. quantity: type: number title: Quantity description: Quantity of the cost item. rate: anyOf: - type: number - type: 'null' title: Rate description: Rate per unit for the cost item. cost: anyOf: - type: number - type: 'null' title: Cost description: Total cost for the item. discount: anyOf: - type: number maximum: 100.0 minimum: 0.0 - type: 'null' title: Discount description: Discount applied to the cost item. lease_term: anyOf: - type: integer - type: 'null' title: Lease Term description: Lease term. buyout_value: anyOf: - type: number - type: 'null' title: Buyout Value description: Buyout value. present_value: anyOf: - type: number - type: 'null' title: Present Value description: Present value of the cost item. residual_value: anyOf: - type: number - type: 'null' title: Residual Value description: Residual value of the cost item. yr1_costs: anyOf: - type: number - type: 'null' title: Yr1 Costs description: Cost for year 1. yr2_costs: anyOf: - type: number - type: 'null' title: Yr2 Costs description: Cost for year 2. yr3_costs: anyOf: - type: number - type: 'null' title: Yr3 Costs description: Cost for year 3. yr4_costs: anyOf: - type: number - type: 'null' title: Yr4 Costs description: Cost for year 4. yr5_costs: anyOf: - type: number - type: 'null' title: Yr5 Costs description: Cost for year 5. yr6_costs: anyOf: - type: number - type: 'null' title: Yr6 Costs description: Cost for year 6. yr7_costs: anyOf: - type: number - type: 'null' title: Yr7 Costs description: Cost for year 7. yr8_costs: anyOf: - type: number - type: 'null' title: Yr8 Costs description: Cost for year 8. yr9_costs: anyOf: - type: number - type: 'null' title: Yr9 Costs description: Cost for year 9. yr10_costs: anyOf: - type: number - type: 'null' title: Yr10 Costs description: Cost for year 10. type: object required: - accrual_type_id - cost_category_type_id - cost_type_id - quantity title: CostCreate description: Cost Create model CostNameUpdate: properties: cost_name: type: string title: Cost Name type: object required: - cost_name title: CostNameUpdate description: Cost Name Model CostOfDelay: properties: formula: type: string title: Formula formula_text: type: string title: Formula Text three_months_cost_of_delay: type: number title: Three Months Cost Of Delay three_months_cost_of_delay_fmt: type: string title: Three Months Cost Of Delay Fmt type: object required: - formula - formula_text - three_months_cost_of_delay - three_months_cost_of_delay_fmt title: CostOfDelay description: Cost of delay (cost of inaction) chart data. CostResponse: properties: name: type: string title: Name description: Name of the cost item. description: anyOf: - type: string - type: 'null' title: Description description: Description of the cost item. alt_cost_description: anyOf: - type: string - type: 'null' title: Alt Cost Description description: Alternative cost description. quantity: type: number title: Quantity description: Quantity of the cost item. rate: type: number title: Rate description: Rate per unit for the cost item. cost: type: number title: Cost description: Total cost for the item. year1_costs: type: number title: Year1 Costs description: Cost for year 1. year2_costs: type: number title: Year2 Costs description: Cost for year 2. year3_costs: type: number title: Year3 Costs description: Cost for year 3. year4_costs: type: number title: Year4 Costs description: Cost for year 4. year5_costs: type: number title: Year5 Costs description: Cost for year 5. year6_costs: type: number title: Year6 Costs description: Cost for year 6. year7_costs: type: number title: Year7 Costs description: Cost for year 7. year8_costs: type: number title: Year8 Costs description: Cost for year 8. year9_costs: type: number title: Year9 Costs description: Cost for year 9. year10_costs: type: number title: Year10 Costs description: Cost for year 10. year1_quantity: type: number title: Year1 Quantity description: Quantity for year 1. year2_quantity: type: number title: Year2 Quantity description: Quantity for year 2. year3_quantity: type: number title: Year3 Quantity description: Quantity for year 3. year4_quantity: type: number title: Year4 Quantity description: Quantity for year 4. year5_quantity: type: number title: Year5 Quantity description: Quantity for year 5. year6_quantity: type: number title: Year6 Quantity description: Quantity for year 6. year7_quantity: type: number title: Year7 Quantity description: Quantity for year 7. year8_quantity: type: number title: Year8 Quantity description: Quantity for year 8. year9_quantity: type: number title: Year9 Quantity description: Quantity for year 9. year10_quantity: type: number title: Year10 Quantity description: Quantity for year 10. subtotal: type: number title: Subtotal description: Subtotal cost before discounts. discount: type: number title: Discount description: Discount applied to the cost item. grand_total: type: number title: Grand Total description: Final cost after applying discounts. term: type: integer title: Term description: Term of the cost agreement. created_at: type: string title: Created At description: Timestamp when the cost item was created. updated_at: type: string title: Updated At description: Timestamp when the cost item was last updated. id: type: integer title: Id description: Unique identifier for the cost item. accrual_type: $ref: '#/components/schemas/AccrualType' description: Details of the accrual type. cost_type: $ref: '#/components/schemas/CostType' description: Details of the cost type. cost_category_type: $ref: '#/components/schemas/CostCategoryType' description: Details of the cost category type. type: object required: - name - quantity - rate - cost - year1_costs - year2_costs - year3_costs - year4_costs - year5_costs - year6_costs - year7_costs - year8_costs - year9_costs - year10_costs - year1_quantity - year2_quantity - year3_quantity - year4_quantity - year5_quantity - year6_quantity - year7_quantity - year8_quantity - year9_quantity - year10_quantity - subtotal - discount - grand_total - term - created_at - updated_at - id - accrual_type - cost_type - cost_category_type title: CostResponse description: Cost Response model CostType: properties: id: type: integer title: Id description: Unique identifier for the cost type. name: type: string title: Name description: Name of the cost type. type: object required: - id - name title: CostType description: Cost Type model CreateAttribution: properties: section_type_id: type: integer title: Section Type Id object_id: type: integer title: Object Id source_type: type: string title: Source Type source: type: string title: Source suggested_value_text: type: string title: Suggested Value Text type: object required: - section_type_id - object_id - source_type - source - suggested_value_text title: CreateAttribution description: Attribution Model CreateCollaboration: properties: first_name: type: string title: First Name last_name: type: string title: Last Name email: type: string format: email title: Email password: anyOf: - type: string - type: 'null' title: Password expires: type: string format: date-time title: Expires benefits_editable: type: integer title: Benefits Editable assumptions_editable: type: integer title: Assumptions Editable account_asset_template_id: anyOf: - type: integer - type: 'null' title: Account Asset Template Id default: 0 discovery_questions_enabled: type: integer title: Discovery Questions Enabled type: object required: - first_name - last_name - email - expires - benefits_editable - assumptions_editable - discovery_questions_enabled title: CreateCollaboration description: Model for creating a collaboration CreateCollaborationResponse: properties: message: type: string title: Message share_details: $ref: '#/components/schemas/CollaborationShare' type: object required: - message - share_details title: CreateCollaborationResponse CreateCompanyPayload: properties: name: type: string title: Name description: The name of the Company user_id: anyOf: - type: integer - type: 'null' title: User Id description: The user ID who created the Company default: 0 account_id: anyOf: - type: integer - type: 'null' title: Account Id description: The account ID of the Company, if account specific default: 0 address1: anyOf: - type: string - type: 'null' title: Address1 description: The first line of the address of the Company default: '' city: anyOf: - type: string - type: 'null' title: City description: The city of the Company default: '' zip: anyOf: - type: string - type: 'null' title: Zip description: The ZIP code of the Company default: '' state: anyOf: - type: string - type: 'null' title: State description: The state of the Company default: '' country_id: anyOf: - type: integer - type: 'null' title: Country Id description: The country ID of the Company default: 0 country: anyOf: - type: string - type: 'null' title: Country description: The name of the country of the Company default: '' account_defined_id: anyOf: - type: string - type: 'null' title: Account Defined Id description: An account-defined ID associated with the Company default: '' from_calculator: anyOf: - type: integer - type: 'null' title: From Calculator description: Denotes whether the company is from a calculator Value Proposition default: 0 type: object required: - name title: CreateCompanyPayload description: CreateCompanyPayload Model CreateShare: properties: user_id: type: integer title: User Id description: Id of user the share is for share_role_type_id: type: integer title: Share Role Type Id description: Id for the share role type from_crm: anyOf: - type: integer - type: 'null' title: From Crm description: If created from crm default: 0 type: object required: - user_id - share_role_type_id title: CreateShare description: Model for creating a share CreateValuePropPayload: properties: company_id: anyOf: - type: integer - type: string title: Company Id description: ID of the Company for the ValueProp sfoide: anyOf: - type: string - type: 'null' title: Sfoide description: SFDC Opportunity ID Encoded from Salesforce name: anyOf: - type: string - type: 'null' title: Name description: Name of the Value Proposition user_id_for_sfdc: anyOf: - type: integer - type: 'null' title: User Id For Sfdc creation_source: type: string enum: - user - dynamic_discovery - autovp - chat - ai title: Creation Source description: 'Source that originated the Value Proposition creation. One of: user, dynamic_discovery, autovp, chat, ai.' default: user type: object required: - company_id title: CreateValuePropPayload description: CreateValuePropPayload model CurrencyType: properties: id: anyOf: - type: integer - type: 'null' title: Id description: The ID for the currency type name: anyOf: - type: string - type: 'null' title: Name description: The name of the currency type description: anyOf: - type: string - type: 'null' title: Description description: A brief description of the currency type abbreviation: anyOf: - type: string - type: 'null' title: Abbreviation description: The abbreviation for the currency type rate: anyOf: - type: number - type: 'null' title: Rate description: The exchange rate for the currency decoration: anyOf: - type: string - type: 'null' title: Decoration description: The symbol or decoration for the currency type: object title: CurrencyType description: Model representing a currency type. CurrentUser: properties: id: type: integer title: Id description: Internal value_user_id of the authenticated user email: type: string title: Email description: Email of the authenticated user name: type: string title: Name description: Full name of the authenticated user account_id: type: integer title: Account Id description: Account id of the authenticated user language_type_id: type: integer title: Language Type Id description: Language preference id of the authenticated user type: object required: - id - email - name - account_id - language_type_id title: CurrentUser description: Authenticated user response model DiscoveryAnswer: properties: account_discovery_question_id: type: integer title: Account Discovery Question Id description: ID of the discovery question answer: type: string title: Answer description: The answer to the discovery question value_prop_id: anyOf: - type: integer - type: 'null' title: Value Prop Id description: The value prop ID user_id: anyOf: - type: integer - type: 'null' title: User Id description: The user ID updating the answer type: object required: - account_discovery_question_id - answer title: DiscoveryAnswer description: Discovery Question Answer Model DiscoveryAnswerPayload: properties: discovery_questions: items: $ref: '#/components/schemas/DiscoveryAnswer' type: array title: Discovery Questions description: List of answers to discovery questions type: object required: - discovery_questions title: DiscoveryAnswerPayload description: Discovery Question Answer Payload Model DiscoveryQuestion: properties: account_discovery_question_id: type: integer title: Account Discovery Question Id description: ID of the discovery question name: type: string title: Name description: The name of the question description: type: string title: Description description: A description of the question default: '' question_type_id: type: integer title: Question Type Id description: The ID for the type of question tag_type_id: type: integer title: Tag Type Id description: The ID for the tag type required: type: boolean title: Required description: Indicates if the question is required value_prop_id: type: integer title: Value Prop Id description: The ID for the value proposition answer: type: string title: Answer description: The answer to the question, if provided question_tag: type: string title: Question Tag description: A tag associated with the question default: '' placeholder_text: type: string title: Placeholder Text description: Text that can be used as a placeholder in the question default: '' sequence: type: integer title: Sequence description: The sequence for the question default_active: anyOf: - type: boolean - type: 'null' title: Default Active description: Indicates if the question is active by default default: false ai_updatable: type: boolean title: Ai Updatable description: Indicates if the question is eligible for AI updates default: true sections: anyOf: - items: $ref: '#/components/schemas/DiscoveryQuestionSection' type: array - type: 'null' title: Sections description: A list of sections the question belongs to is_placeholder_text: anyOf: - type: boolean - type: 'null' title: Is Placeholder Text description: Indicates if the placeholder text is present or not default: false source_attribution: anyOf: - type: string - type: 'null' title: Source Attribution attribution_link: anyOf: - type: string - type: 'null' title: Attribution Link attribution_tooltip: anyOf: - type: string - type: 'null' title: Attribution Tooltip revert_value: anyOf: - type: string - type: 'null' title: Revert Value type: object required: - account_discovery_question_id - name - question_type_id - tag_type_id - required - value_prop_id - answer - sequence title: DiscoveryQuestion description: DiscoveryQuestion Model DiscoveryQuestionSection: properties: id: type: integer title: Id description: The ID of the section name: type: string title: Name description: The name of the section type: object required: - id - name title: DiscoveryQuestionSection description: DiscoveryQuestionSection Model Done: properties: done: anyOf: - type: integer - type: 'null' title: Done description: Done flag scenario_done: anyOf: - type: integer - type: 'null' title: Scenario Done description: Scenario done flag situation_done: anyOf: - type: integer - type: 'null' title: Situation Done description: Situation done flag scalers_done: anyOf: - type: integer - type: 'null' title: Scalers Done description: Scalers done flag key_data_done: anyOf: - type: integer - type: 'null' title: Key Data Done description: Key Data done flag review_benefits_done: anyOf: - type: integer - type: 'null' title: Review Benefits Done description: Review Benefits data done flag customer_investment_done: anyOf: - type: integer - type: 'null' title: Customer Investment Done description: Customer Investment done flag type: object title: Done description: Done model DynamicDiscoveryResponse: properties: has_permission: type: boolean title: Has Permission user_id: anyOf: - type: integer - type: 'null' title: User Id account_id: anyOf: - type: integer - type: 'null' title: Account Id solutions: anyOf: - items: $ref: '#/components/schemas/value_proposition__dynamic_discovery__models__Solution' type: array - type: 'null' title: Solutions default: [] available_solutions: anyOf: - items: $ref: '#/components/schemas/value_proposition__dynamic_discovery__models__Solution' type: array - type: 'null' title: Available Solutions default: [] salesforce_field: anyOf: - type: string - type: 'null' title: Salesforce Field trigger_stages: anyOf: - items: type: string type: array - type: 'null' title: Trigger Stages default: [] trigger_types: anyOf: - items: type: string type: array - type: 'null' title: Trigger Types default: [] trigger_enabled_since: anyOf: - type: string format: date-time - type: 'null' title: Trigger Enabled Since category_updates: type: boolean title: Category Updates default: false type: object required: - has_permission title: DynamicDiscoveryResponse description: Model for dynamic discovery Element: properties: id: type: string title: Id description: ID for the Element sequence: anyOf: - type: string - type: integer title: Sequence description: Sequence of the Element name: type: string title: Name description: Name of the Element description: anyOf: - type: string - type: 'null' title: Description description: Description of the Element default: '' situation_category_id: anyOf: - type: string - type: 'null' title: Situation Category Id description: Situation Category ID selected: type: boolean title: Selected description: Selected status of the Element child_element_type_id: anyOf: - type: string - type: 'null' title: Child Element Type Id description: Select-type for this element's children (maps to fact_situation_element_types) can_set_child_element: anyOf: - type: boolean - type: 'null' title: Can Set Child Element description: Whether the element accepts child elements child_multi_select: type: boolean title: Child Multi Select description: 'Derived: children allow multi-select (type 2 or 4)' default: false child_question_type: anyOf: - type: string - type: 'null' title: Child Question Type description: Derived label for the children sub-list control (Radio Button / Check Box / Drop Down) children: anyOf: - items: $ref: '#/components/schemas/ChildElement' type: array - type: 'null' title: Children description: Children of the Element created_at: type: string title: Created At description: Date when the Element was created updated_at: type: string title: Updated At description: Date when the Element was updated type: object required: - id - sequence - name - selected - created_at - updated_at title: Element description: Element model ExpenseType: properties: id: type: integer title: Id description: Unique identifier for the expense type. name: type: string title: Name description: Name of the expense type. abbr: anyOf: - type: string - type: 'null' title: Abbr description: Abbreviation of the expense type. description: anyOf: - type: string - type: 'null' title: Description description: Description of the expense type. created: anyOf: - type: string - type: 'null' title: Created description: Timestamp when the expense type was created. modified: anyOf: - type: string - type: 'null' title: Modified description: Timestamp when the expense type was last updated. type: object required: - id - name title: ExpenseType description: Expense Type model ExternalTracker: properties: value_prop_name: type: string title: Value Prop Name description: Name of the value proposition value_prop_id: type: integer title: Value Prop Id description: ID of the value proposition company_name: type: string title: Company Name description: Name of the company original_user_id: type: string title: Original User Id description: Original user ID original_value_prop_id: anyOf: - type: string - type: 'null' title: Original Value Prop Id description: Original value proposition ID current_benefits: type: string title: Current Benefits description: Current benefits (formatted) current_benefits_raw: type: number title: Current Benefits Raw description: Current benefits (raw) expected_benefits: type: string title: Expected Benefits description: Expected benefits (formatted) expected_benefits_raw: type: number title: Expected Benefits Raw description: Expected benefits (raw) achieved_benefits: type: string title: Achieved Benefits description: Achieved benefits (formatted) achieved_benefits_raw: type: number title: Achieved Benefits Raw description: Achieved benefits (raw) current_payback: type: string title: Current Payback description: Current payback (formatted) current_payback_raw: type: number title: Current Payback Raw description: Current payback (raw) expected_payback: type: string title: Expected Payback description: Expected payback (formatted) expected_payback_raw: type: number title: Expected Payback Raw description: Expected payback (raw) achieved_payback: type: string title: Achieved Payback description: Achieved payback (formatted) achieved_payback_raw: type: number title: Achieved Payback Raw description: Achieved payback (raw) expected_roi: type: string title: Expected Roi description: Expected ROI (formatted) expected_roi_raw: type: number title: Expected Roi Raw description: Expected ROI (raw) achieved_roi: type: string title: Achieved Roi description: Achieved ROI (formatted) achieved_roi_raw: type: number title: Achieved Roi Raw description: Achieved ROI (raw) expected_costs: type: string title: Expected Costs description: Expected costs (formatted) expected_costs_raw: type: number title: Expected Costs Raw description: Expected costs (raw) assigned_by: type: string title: Assigned By description: User who assigned the value prop created: type: string title: Created description: Creation timestamp valueprop_create_date_sfdc: type: string title: Valueprop Create Date Sfdc description: Creation date in SFDC (added on 1/31/22) creators_name: type: string title: Creators Name description: Creator's name (added on 1/31/22) last_modified_date: type: string title: Last Modified Date description: Last modified date (added on 1/31/22) last_modified_by_name: type: string title: Last Modified By Name description: Last modified by (added on 1/31/22) variance: type: string title: Variance description: Variance value (formatted)(added on 7/18/2023) variance_raw: type: number title: Variance Raw description: Variance value (raw)(added on 7/18/2023) type: object required: - value_prop_name - value_prop_id - company_name - original_user_id - current_benefits - current_benefits_raw - expected_benefits - expected_benefits_raw - achieved_benefits - achieved_benefits_raw - current_payback - current_payback_raw - expected_payback - expected_payback_raw - achieved_payback - achieved_payback_raw - expected_roi - expected_roi_raw - achieved_roi - achieved_roi_raw - expected_costs - expected_costs_raw - assigned_by - created - valueprop_create_date_sfdc - creators_name - last_modified_date - last_modified_by_name - variance - variance_raw title: ExternalTracker description: ValueTracker Model ExternalVP: properties: id: type: string title: Id description: Id of the value proposition name: type: string title: Name description: Name of the value proposition company_id: type: string title: Company Id description: Id of the associated company wacc: type: string title: Wacc description: Weighted Average Cost of Capital term: type: string title: Term description: Term duration of the proposition total_benefits: type: string title: Total Benefits description: Formatted total benefits total_benefits_raw: type: number title: Total Benefits Raw description: Raw total benefits value total_costs: type: string title: Total Costs description: Formatted total costs total_costs_raw: type: number title: Total Costs Raw description: Raw total costs value npv_fmt: type: string title: Npv Fmt description: Formatted Net Present Value roi_decorated: type: string title: Roi Decorated description: Decorated Return on Investment tco_fmt: type: string title: Tco Fmt description: Formatted Total Cost of Ownership three_month_cost_of_inaction_fmt: type: string title: Three Month Cost Of Inaction Fmt description: Formatted 3-month cost of inaction payback: type: string title: Payback description: Payback period vp_status: anyOf: - type: string - type: 'null' title: Vp Status description: Status of the value proposition default: '' created: type: string title: Created description: Creation date creators_name: type: string title: Creators Name description: Creator's name last_modified_date: type: string title: Last Modified Date description: Date last modified last_modified_by_name: type: string title: Last Modified By Name description: Name of last modifier DL_VC_Discovery_Question_1_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 1 C description: Discovery Question 1 DL_VC_Discovery_Question_2_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 2 C description: Discovery Question 2 DL_VC_Discovery_Question_3_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 3 C description: Discovery Question 3 DL_VC_Discovery_Question_4_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 4 C description: Discovery Question 4 DL_VC_Discovery_Question_5_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 5 C description: Discovery Question 5 DL_VC_Discovery_Question_6_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 6 C description: Discovery Question 6 DL_VC_Discovery_Question_7_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 7 C description: Discovery Question 7 DL_VC_Discovery_Question_8_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 8 C description: Discovery Question 8 DL_VC_Discovery_Question_9_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 9 C description: Discovery Question 9 DL_VC_Discovery_Question_10_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Question 10 C description: Discovery Question 10 DL_VC_Discovery_Answer_1_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 1 C description: Discovery Answer 1 DL_VC_Discovery_Answer_2_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 2 C description: Discovery Answer 2 DL_VC_Discovery_Answer_3_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 3 C description: Discovery Answer 3 DL_VC_Discovery_Answer_4_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 4 C description: Discovery Answer 4 DL_VC_Discovery_Answer_5_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 5 C description: Discovery Answer 5 DL_VC_Discovery_Answer_6_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 6 C description: Discovery Answer 6 DL_VC_Discovery_Answer_7_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 7 C description: Discovery Answer 7 DL_VC_Discovery_Answer_8_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 8 C description: Discovery Answer 8 DL_VC_Discovery_Answer_9_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 9 C description: Discovery Answer 9 DL_VC_Discovery_Answer_10_c: anyOf: - type: string - type: 'null' title: Dl Vc Discovery Answer 10 C description: Discovery Answer 10 type: object required: - id - name - company_id - wacc - term - total_benefits - total_benefits_raw - total_costs - total_costs_raw - npv_fmt - roi_decorated - tco_fmt - three_month_cost_of_inaction_fmt - payback - created - creators_name - last_modified_date - last_modified_by_name title: ExternalVP description: ExternalVPGroup model ExternalVPGroup: properties: id: type: string title: Id description: Id of the value proposition name: type: string title: Name description: Name of the value proposition company_id: type: string title: Company Id description: Id of the associated company total_benefits_fmt: type: string title: Total Benefits Fmt description: Formatted total benefits total_costs_fmt: type: string title: Total Costs Fmt description: Formatted total costs npv: type: string title: Npv description: Net Present Value roi: type: string title: Roi description: Return on Investment tco: type: string title: Tco description: Total Cost of Ownership cost_of_delay: type: string title: Cost Of Delay description: Cost of Delay payback: type: string title: Payback description: Payback period benefits_per_transaction_fmt: type: string title: Benefits Per Transaction Fmt description: Formatted benefits per transaction created: type: string title: Created description: Creation date of the record vp_creator_name: type: string title: Vp Creator Name description: Name of the VP creator last_modified_date: type: string title: Last Modified Date description: Date of last modification last_modified_by_name: type: string title: Last Modified By Name description: Name of person who last modified type: object required: - id - name - company_id - total_benefits_fmt - total_costs_fmt - npv - roi - tco - cost_of_delay - payback - benefits_per_transaction_fmt - created - vp_creator_name - last_modified_date - last_modified_by_name title: ExternalVPGroup description: ExternalVPGroup model Factor: properties: id: type: string title: Id description: ID for the Factor sequence: type: string title: Sequence description: Sequence of the Factor name: type: string title: Name description: Name of the Factor description: type: string title: Description description: Description of the Factor unit_type_id: type: string title: Unit Type Id description: Unit type of the Factor unit_type: $ref: '#/components/schemas/UnitType' description: Unit Type object for the Factor Unit Type precision: type: string title: Precision description: Decimal precision for the Factor value: anyOf: - type: string - type: integer - type: number title: Value description: Value of the Factor value_fr: anyOf: - type: string - type: integer - type: 'null' title: Value Fr description: Value of the Factor default: 0 value_fmt: anyOf: - type: string - type: integer - type: 'null' title: Value Fmt description: Value of the Factor default: 0 source_type: anyOf: - $ref: '#/components/schemas/value_proposition__factors__models__SourceType' - type: 'null' description: SourceType of the Factor has_scratchpad: anyOf: - type: integer - type: 'null' title: Has Scratchpad description: Denotes if the factor has a scratchpad default: 0 scratchpad_used: anyOf: - type: integer - type: 'null' title: Scratchpad Used description: Denotes if factor scratchpad is in use default: 0 literal_number: anyOf: - type: boolean - type: 'null' title: Literal Number description: Denotes whether the factor should be treated as a literal default: false ai_updatable: anyOf: - type: boolean - type: 'null' title: Ai Updatable description: Whether the factor is eligible for AI updates default: false validation: anyOf: - $ref: '#/components/schemas/Validation' - type: 'null' source_attribution: anyOf: - type: string - type: 'null' title: Source Attribution attribution_link: anyOf: - type: string - type: 'null' title: Attribution Link attribution_tooltip: anyOf: - type: string - type: 'null' title: Attribution Tooltip revert_value: anyOf: - type: number - type: 'null' title: Revert Value type: object required: - id - sequence - name - description - unit_type_id - unit_type - precision - value title: Factor description: Factor model FactorGroup: properties: id: type: string title: Id description: ID for the Factor Group name: type: string title: Name description: Name of the Factor Group sequence: type: string title: Sequence description: Sequence of the Factor Group factors: items: $ref: '#/components/schemas/Factor' type: array title: Factors description: Factors belonging to the Factor Group type: object required: - id - name - sequence - factors title: FactorGroup description: FactorGroup model FactorOverrideNamePayload: properties: factor_id: type: integer title: Factor Id description: ID of the factor override_name: type: string title: Override Name description: Overriding the factor name type: object required: - factor_id - override_name title: FactorOverrideNamePayload description: FactorOverrideNamePayload model FactorPayload: properties: factors: items: $ref: '#/components/schemas/FactorValue' type: array title: Factors description: The factors and values being saved type: object required: - factors title: FactorPayload description: FactorPayload model FactorValue: properties: id: type: string title: Id description: ID of the Factor being saved source_type_id: anyOf: - type: integer - type: 'null' title: Source Type Id description: 'Source type: will always be 4, Value Execution will change to Customer if needed' default: '4' value: anyOf: - type: string - type: integer - type: number title: Value description: Value of the Factor being saved year: anyOf: - type: integer - type: 'null' title: Year description: Year in the factor default: 1 validating_user_name: anyOf: - type: string - type: 'null' title: Validating User Name type: object required: - id - value title: FactorValue description: FactorValue model FilterByOption: type: string enum: - value_category - functional_objectives - painpoints - capabilities - operational_objectives - impact_types - accrual_types title: FilterByOption description: Filter options for benefits-by-type grouping FormatType: properties: id: type: integer title: Id description: Unique identifier for the format type. name: type: string title: Name description: Name of the format type. description: anyOf: - type: string - type: 'null' title: Description description: Description of the format type. type: object required: - id - name title: FormatType description: Detailed Format Model FormattedResponse_VPGroupResult_: properties: result: $ref: '#/components/schemas/VPGroupResult' type: object required: - result title: FormattedResponse[VPGroupResult] FormattedResponse_ValuePropResult_: properties: result: $ref: '#/components/schemas/ValuePropResult' type: object required: - result title: FormattedResponse[ValuePropResult] FormattedResponse_list_ExternalTracker__: properties: result: items: $ref: '#/components/schemas/ExternalTracker' type: array title: Result type: object required: - result title: FormattedResponse[list[ExternalTracker]] GroupingOverridePayload: properties: grouping_id: type: integer title: Grouping Id description: ID of the grouping to override. name: type: string title: Name description: New name for the grouping. grouping_type: type: string title: Grouping Type description: Type of the grouping (e.g., value_category, etc.) type: object required: - grouping_id - name - grouping_type title: GroupingOverridePayload description: Payload model for grouping override endpoint. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError HealthCheckResponse: properties: status: type: string title: Status default: OK type: object title: HealthCheckResponse description: Health check response ListMode: type: integer enum: - 1 - 2 - 3 title: ListMode description: Mode for filtering value propositions by status. LogEntry: properties: action: type: string title: Action description: The action performed (e.g., Update) action_type_id: type: integer title: Action Type Id description: The ID of the action type first_name: type: string title: First Name description: The first name of the user performing the action id: type: integer title: Id description: The ID associated with the log entry last_name: type: string title: Last Name description: The last name of the user performing the action log_text: anyOf: - type: string - type: 'null' title: Log Text description: A description of the action or event default: '' modified: anyOf: - type: string format: date-time - type: 'null' title: Modified description: The timestamp of when the action was performed new_val: anyOf: - type: string - type: 'null' title: New Val description: The new value after the action (if any) default: '' object_id: anyOf: - type: integer - type: 'null' title: Object Id description: The ID of the object being updated default: '' object_name: anyOf: - type: string - type: 'null' title: Object Name description: The name of the object being updated default: '' previous_val: anyOf: - type: string - type: 'null' title: Previous Val description: The previous value before the action (if any) default: '' section: type: string title: Section description: The section or area where the update occurred section_type_id: type: integer title: Section Type Id description: The ID of the section type user_id: type: integer title: User Id description: The user ID of the person performing the action user_name: anyOf: - type: string - type: 'null' title: User Name description: The username of the person performing the action default: '' value_prop_id: type: integer title: Value Prop Id description: The ID of the value proposition being updated type: object required: - action - action_type_id - first_name - id - last_name - section - section_type_id - user_id - value_prop_id title: LogEntry description: Class to represent a log entry Mapping: properties: crm: anyOf: - type: string - type: 'null' title: Crm description: CRM for mapping default: salesforce account_id: anyOf: - type: integer - type: 'null' title: Account Id description: Account to which the mapping belongs value_object_type: anyOf: - type: string - type: 'null' title: Value Object Type description: Type of Value object being mapped default: factor value_object_id: anyOf: - type: integer - type: 'null' title: Value Object Id description: Value ID for the object being mapping default: 0 crm_object_type: type: string title: Crm Object Type description: CRM object being mapped crm_object_field: type: string title: Crm Object Field description: CRM object field being mapped type: object required: - crm_object_type - crm_object_field title: Mapping description: Mapping model MappingResponse: properties: crm: anyOf: - type: string - type: 'null' title: Crm description: CRM for mapping default: salesforce account_id: anyOf: - type: integer - type: 'null' title: Account Id description: Account to which the mapping belongs value_object_type: anyOf: - type: string - type: 'null' title: Value Object Type description: Type of Value object being mapped default: factor value_object_id: anyOf: - type: integer - type: 'null' title: Value Object Id description: Value ID for the object being mapping default: 0 crm_object_type: type: string title: Crm Object Type description: CRM object being mapped crm_object_field: type: string title: Crm Object Field description: CRM object field being mapped id: type: integer title: Id description: ID for the account CRM mapping type: object required: - crm_object_type - crm_object_field title: MappingResponse description: Mapping Response model MessageResponse: properties: message: type: string title: Message type: object required: - message title: MessageResponse description: Response model for simple message responses NumberFormatType: properties: id: anyOf: - type: integer - type: 'null' title: Id description: The ID for the number format type name: anyOf: - type: string - type: 'null' title: Name description: The name of the number format type description: anyOf: - type: string - type: 'null' title: Description description: A description of the number format type locale: anyOf: - type: string - type: 'null' title: Locale description: The locale associated with the number format type type: object title: NumberFormatType description: Model representing a number format type. OneTimeBenefitCreate: properties: name: type: string title: Name description: Benefit name stored as metric_name description: type: string title: Description description: Benefit description account_solution_id: type: integer title: Account Solution Id description: Solution this benefit belongs to value_category_id: type: integer title: Value Category Id description: Value category for this benefit accrual_type_id: type: integer title: Accrual Type Id description: Accrual type for benefit phasing driver_factor_id: type: integer title: Driver Factor Id description: Driver factor (aggregated) ID improvement_factor_id: type: integer title: Improvement Factor Id description: Improvement factor (aggregated) ID financial_factor_id: type: integer title: Financial Factor Id description: Financial factor (aggregated) ID driver_value: type: number title: Driver Value description: Driver baseline answer / estimate value improvement_value: type: number title: Improvement Value description: Improvement value stored as conservative/probable/aggressive financial_value: type: number title: Financial Value description: Financial baseline answer / estimate value impact_type_id: type: integer title: Impact Type Id description: Impact type ID (default 1) default: 1 unit_type_id: anyOf: - type: integer - type: 'null' title: Unit Type Id description: Unit type override; used when improvement_factor_id == 1 unique_type_id: type: integer title: Unique Type Id description: Unique type ID (default 1) default: 1 current_effort: type: number title: Current Effort description: Current effort value (normalized if percent unit) default: 0 features: type: string title: Features description: Features text default: '' area_type_id: items: type: integer type: array title: Area Type Id description: List of area type IDs to link default_na: type: integer title: Default Na description: Default N/A flag default: 0 sequence: type: integer title: Sequence description: Display sequence order default: 0 expense_type_id: type: integer title: Expense Type Id description: Expense type ID default: 0 quantified: type: integer title: Quantified description: Quantified flag default: 1 soft: type: integer title: Soft description: Soft benefit flag default: 0 benefit_type_id: type: integer title: Benefit Type Id description: Benefit type ID default: 1 tco_name: type: string title: Tco Name description: TCO name text default: '' value_statement: type: string title: Value Statement description: Value statement text default: '' course_correction: type: string title: Course Correction description: Course correction text default: '' metric_note_2: anyOf: - type: string - type: 'null' title: Metric Note 2 description: Metric note 2 text metric_note_3: anyOf: - type: string - type: 'null' title: Metric Note 3 description: Metric note 3 text metric_note_2_cf: type: integer title: Metric Note 2 Cf description: Metric note 2 carry-forward flag default: 1 metric_note_3_cf: type: integer title: Metric Note 3 Cf description: Metric note 3 carry-forward flag default: 1 project_id: type: integer title: Project Id description: Project ID default: 0 account_functional_objective_id: anyOf: - type: integer - type: 'null' title: Account Functional Objective Id description: Functional objective to link account_operational_objective_id: anyOf: - type: integer - type: 'null' title: Account Operational Objective Id description: Operational objective to link account_capability_id: anyOf: - type: integer - type: 'null' title: Account Capability Id description: Capability to link account_painpoint_id: anyOf: - type: integer - type: 'null' title: Account Painpoint Id description: Pain point to link value_survey_benefit: type: integer title: Value Survey Benefit description: Flag to insert value survey metric links default: 0 value_survey_id: items: type: integer type: array title: Value Survey Id description: Survey IDs to link when value_survey_benefit is 1 type: object required: - name - description - account_solution_id - value_category_id - accrual_type_id - driver_factor_id - improvement_factor_id - financial_factor_id - driver_value - improvement_value - financial_value title: OneTimeBenefitCreate description: Payload for creating a one-time (on-the-fly) benefit. examples: - summary: required only value: account_solution_id: 42 accrual_type_id: 1 description: Automate invoice processing to cut manual effort driver_factor_id: 100 driver_value: 1200.0 financial_factor_id: 300 financial_value: 85.0 improvement_factor_id: 200 improvement_value: 25.0 name: Reduce manual processing time value_category_id: 20 - summary: all fields value: account_capability_id: 33 account_functional_objective_id: 11 account_operational_objective_id: 22 account_painpoint_id: 44 account_solution_id: 42 accrual_type_id: 1 area_type_id: - 1 - 3 benefit_type_id: 1 course_correction: Review monthly against FTE hours saved current_effort: 480.0 default_na: 0 description: Automate invoice processing to cut manual effort driver_factor_id: 100 driver_value: 1200.0 expense_type_id: 2 features: Automation, AI-assisted routing financial_factor_id: 300 financial_value: 85.0 impact_type_id: 2 improvement_factor_id: 200 improvement_value: 25.0 metric_note_2: Assumes 80% straight-through processing metric_note_2_cf: 1 metric_note_3: Excludes exception handling cost metric_note_3_cf: 1 name: Reduce manual processing time project_id: 7 quantified: 1 sequence: 5 soft: 0 tco_name: Process Automation TCO unique_type_id: 1 unit_type_id: 17 value_category_id: 20 value_statement: Reduce manual invoice processing by 25% over 12 months value_survey_benefit: 1 value_survey_id: - 55 - 66 OneTimeBenefitPatch: properties: name: anyOf: - type: string - type: 'null' title: Name description: Benefit name stored as metric_name description: anyOf: - type: string - type: 'null' title: Description description: Benefit description value_category_id: anyOf: - type: integer - type: 'null' title: Value Category Id description: Value category for this benefit accrual_type_id: anyOf: - type: integer - type: 'null' title: Accrual Type Id description: Accrual type for benefit phasing driver_factor_id: anyOf: - type: integer - type: 'null' title: Driver Factor Id description: Driver factor (aggregated) ID improvement_factor_id: anyOf: - type: integer - type: 'null' title: Improvement Factor Id description: Improvement factor (aggregated) ID financial_factor_id: anyOf: - type: integer - type: 'null' title: Financial Factor Id description: Financial factor (aggregated) ID driver_value: anyOf: - type: number - type: 'null' title: Driver Value description: Driver baseline answer / estimate value improvement_value: anyOf: - type: number - type: 'null' title: Improvement Value description: Improvement value stored as conservative/probable/aggressive financial_value: anyOf: - type: number - type: 'null' title: Financial Value description: Financial baseline answer / estimate value impact_type_id: anyOf: - type: integer - type: 'null' title: Impact Type Id description: Impact type ID unit_type_id: anyOf: - type: integer - type: 'null' title: Unit Type Id description: Unit type override current_effort: anyOf: - type: number - type: 'null' title: Current Effort description: Current effort value features: anyOf: - type: string - type: 'null' title: Features description: Features text quantified: anyOf: - type: integer - type: 'null' title: Quantified description: Quantified flag soft: anyOf: - type: integer - type: 'null' title: Soft description: Soft benefit flag tco_name: anyOf: - type: string - type: 'null' title: Tco Name description: TCO name text value_statement: anyOf: - type: string - type: 'null' title: Value Statement description: Value statement text course_correction: anyOf: - type: string - type: 'null' title: Course Correction description: Course correction text metric_note_2: anyOf: - type: string - type: 'null' title: Metric Note 2 description: Metric note 2 text metric_note_3: anyOf: - type: string - type: 'null' title: Metric Note 3 description: Metric note 3 text metric_note_2_cf: anyOf: - type: integer - type: 'null' title: Metric Note 2 Cf description: Metric note 2 carry-forward flag metric_note_3_cf: anyOf: - type: integer - type: 'null' title: Metric Note 3 Cf description: Metric note 3 carry-forward flag type: object title: OneTimeBenefitPatch description: Payload for partial update of a one-time benefit. OneTimeBenefitResponse: properties: value_prop_metric_id: type: integer title: Value Prop Metric Id description: ID of the created value_prop_metrics row account_solution_metric_id: type: integer title: Account Solution Metric Id description: ID of the created account_solution_metrics row value_prop_id: type: integer title: Value Prop Id description: Value prop ID value_category_id: type: integer title: Value Category Id description: Value category ID name: type: string title: Name description: Benefit name driver_value: type: number title: Driver Value description: Normalized driver value stored improvement_value: type: number title: Improvement Value description: Normalized improvement value stored financial_value: type: number title: Financial Value description: Normalized financial value stored current_effort: type: number title: Current Effort description: Normalized current effort stored unit_type_id: type: integer title: Unit Type Id description: Resolved unit type ID stored warning: anyOf: - type: string - type: 'null' title: Warning description: Present when the benefit was persisted but a post-commit step (links or recalculation) failed; totals may be stale until benefits are recalculated type: object required: - value_prop_metric_id - account_solution_metric_id - value_prop_id - value_category_id - name - driver_value - improvement_value - financial_value - current_effort - unit_type_id title: OneTimeBenefitResponse description: Response model for a created one-time benefit. PaybackChart: properties: net: items: type: number type: array title: Net net_fmt: items: type: string type: array title: Net Fmt payback: type: string title: Payback payback_formula: type: string title: Payback Formula payback_formula_text: type: string title: Payback Formula Text years: items: type: string type: array title: Years type: object required: - net - net_fmt - payback - payback_formula - payback_formula_text - years title: PaybackChart description: Payback chart data for a value proposition. Privilege: properties: privilege_id: type: integer title: Privilege Id description: Id of privilege name: type: string title: Name description: Name of privilege type: object required: - privilege_id - name title: Privilege description: Privilege model Product: properties: product_id: type: integer title: Product Id description: Id of product name: type: string title: Name description: Name of product type: object required: - product_id - name title: Product description: Product model ROIChart: properties: years: items: type: string type: array title: Years benefits: items: type: string type: array title: Benefits benefits_fmt: items: type: string type: array title: Benefits Fmt costs: items: type: string type: array title: Costs costs_fmt: items: type: string type: array title: Costs Fmt roi: items: anyOf: - type: string - type: integer type: array title: Roi roi_fmt: items: type: string type: array title: Roi Fmt roi_formula: type: string title: Roi Formula type: object required: - years - benefits - benefits_fmt - costs - costs_fmt - roi - roi_fmt - roi_formula title: ROIChart description: Model for ROI Chart data ReassignValuePropPayload: properties: user_id: type: integer title: User Id description: ID of the user to take over the value prop type: object required: - user_id title: ReassignValuePropPayload description: ReassignValuePropPayload model RefreshValuePropGroupPayload: properties: sfdc_vp_id: type: string title: Sfdc Vp Id description: The sfdc value prop ID value_prop_group_id: type: string title: Value Prop Group Id description: The value prop group ID type: object required: - sfdc_vp_id - value_prop_group_id title: RefreshValuePropGroupPayload description: Model representing the refresh value proposition group payload. RefreshValuePropPayload: properties: sfdc_vp_id: type: string title: Sfdc Vp Id description: The sfdc value prop ID value_prop_id: type: string title: Value Prop Id description: The value prop ID type: object required: - sfdc_vp_id - value_prop_id title: RefreshValuePropPayload description: Model representing the refresh value proposition payload. RefreshValueTrackerPayload: properties: sfdc_vt_id: type: string title: Sfdc Vt Id description: The sfdc value tracker ID value_prop_id: type: string title: Value Prop Id description: The value prop ID type: object required: - sfdc_vt_id - value_prop_id title: RefreshValueTrackerPayload description: Model representing the refresh value tracker payload. ScorecardResponse: properties: value_prop_status: type: integer title: Value Prop Status description: Overall value proposition status threshold_types: items: $ref: '#/components/schemas/ThresholdStatus' type: array title: Threshold Types description: List of threshold status evaluations phasing_activated: type: boolean title: Phasing Activated description: Whether phasing is activated driver_override: type: number title: Driver Override description: Driver override percentage financial_override: type: number title: Financial Override description: Financial override percentage impact_override: type: number title: Impact Override description: Impact override percentage type: object required: - value_prop_status - threshold_types - phasing_activated - driver_override - financial_override - impact_override title: ScorecardResponse description: Complete scorecard response model Scratchpad: properties: id: type: integer title: Id description: Unique identifier for the scratchpad value_prop_id: type: integer title: Value Prop Id description: ID for the associated value prop account_scratchpad_id: type: integer title: Account Scratchpad Id description: ID for the associated account scratchpad factor_id: type: integer title: Factor Id description: ID for the factor factor_type_id: type: integer title: Factor Type Id description: ID for the factor type value_prop_metric_id: type: integer title: Value Prop Metric Id description: ID for the value prop metric is_current_effort: type: string title: Is Current Effort description: Indicates if the effort is current (as a string) formula: type: string title: Formula description: Formula used for the calculation total: type: number title: Total description: Total value for the calculation created: type: string title: Created description: Creation timestamp modified: type: string title: Modified description: Last modified timestamp value_prop_scratchpad_id: type: integer title: Value Prop Scratchpad Id description: ID for the associated value prop scratchpad factor_name: type: string title: Factor Name description: Name of the factor unit_type_id: type: integer title: Unit Type Id unit_type: type: string title: Unit Type abbr: anyOf: - type: string - type: 'null' title: Abbr default: '' type: object required: - id - value_prop_id - account_scratchpad_id - factor_id - factor_type_id - value_prop_metric_id - is_current_effort - formula - total - created - modified - value_prop_scratchpad_id - factor_name - unit_type_id - unit_type title: Scratchpad description: Scratchpad Model ScratchpadResponse: properties: scratchpad: $ref: '#/components/schemas/Scratchpad' description: The scratchpad data units: items: $ref: '#/components/schemas/ScratchpadUnit' type: array title: Units description: List of units associated with the scratchpad type: object required: - scratchpad - units title: ScratchpadResponse description: Scratchpad Response Model ScratchpadTotalPayload: properties: factor_id: type: string title: Factor Id description: Comma-separated string of factor IDs operator_id: type: string title: Operator Id description: Comma-separated string of operator IDs operand: type: string title: Operand description: Comma-separated string of operands open_paren: type: string title: Open Paren description: Comma-separated string for open parentheses close_paren: type: string title: Close Paren description: Comma-separated string for close parentheses scratchpad_factor_id: type: string title: Scratchpad Factor Id description: Scratchpad factor ID as a string type: object required: - factor_id - operator_id - operand - open_paren - close_paren - scratchpad_factor_id title: ScratchpadTotalPayload description: Scratchpad Total Payload ScratchpadTotalResponse: properties: total: type: number title: Total description: The calculated total for the scratchpad type: object required: - total title: ScratchpadTotalResponse description: Scratchpad Total Response model ScratchpadUnit: properties: id: type: integer title: Id description: Unique identifier for the unit value_prop_scratchpad_id: type: integer title: Value Prop Scratchpad Id description: ID for the associated value prop scratchpad account_scratchpad_unit_id: type: integer title: Account Scratchpad Unit Id description: ID for the associated account scratchpad unit factor_id: type: integer title: Factor Id description: ID for the factor operand: type: number title: Operand description: Operand for the calculation operand_estimate: type: number title: Operand Estimate description: Estimated operand value operand_override: type: number title: Operand Override description: Operand override value operand_source_type_id: type: integer title: Operand Source Type Id description: ID for the operand source type operator_id: type: integer title: Operator Id description: ID for the operator open_paren: type: integer title: Open Paren description: Open parentheses for the expression close_paren: type: integer title: Close Paren description: Close parentheses for the expression name: type: string title: Name description: Name of the unit value_realization_name: anyOf: - type: string - type: 'null' title: Value Realization Name description: Name of the value realization, if any description: type: string title: Description description: Description of the unit factor_precision: type: integer title: Factor Precision description: Precision for the factor abbreviation: type: string title: Abbreviation description: Abbreviation for the unit year1_value: type: number title: Year1 Value description: Value for year 1 year1_value_override: type: number title: Year1 Value Override description: Override value for year 1 year2_value: type: number title: Year2 Value description: Value for year 2 year2_value_override: type: number title: Year2 Value Override description: Override value for year 2 year3_value: type: number title: Year3 Value description: Value for year 3 year3_value_override: type: number title: Year3 Value Override description: Override value for year 3 year4_value: type: number title: Year4 Value description: Value for year 4 year4_value_override: type: number title: Year4 Value Override description: Override value for year 4 year5_value: type: number title: Year5 Value description: Value for year 5 year5_value_override: type: number title: Year5 Value Override description: Override value for year 5 year6_value: type: number title: Year6 Value description: Value for year 6 year6_value_override: type: number title: Year6 Value Override description: Override value for year 6 year7_value: type: number title: Year7 Value description: Value for year 7 year7_value_override: type: number title: Year7 Value Override description: Override value for year 7 year8_value: type: number title: Year8 Value description: Value for year 8 year8_value_override: type: number title: Year8 Value Override description: Override value for year 8 year9_value: type: number title: Year9 Value description: Value for year 9 year9_value_override: type: number title: Year9 Value Override description: Override value for year 9 year10_value: type: number title: Year10 Value description: Value for year 10 year10_value_override: type: number title: Year10 Value Override description: Override value for year 10 unit_type_id: type: integer title: Unit Type Id description: ID for the unit type literal_number: type: integer title: Literal Number description: Literal number associated with the unit unit_type: type: string title: Unit Type description: Type of the unit is_telemetry_data: type: integer title: Is Telemetry Data description: Flag indicating if this is telemetry data function_type_id: type: integer title: Function Type Id description: ID for the function type abbr: type: string title: Abbr description: Abbreviation for the unit years: items: $ref: '#/components/schemas/ScratchpadUnitYear' type: array title: Years description: List of years with corresponding values and overrides type: object required: - id - value_prop_scratchpad_id - account_scratchpad_unit_id - factor_id - operand - operand_estimate - operand_override - operand_source_type_id - operator_id - open_paren - close_paren - name - description - factor_precision - abbreviation - year1_value - year1_value_override - year2_value - year2_value_override - year3_value - year3_value_override - year4_value - year4_value_override - year5_value - year5_value_override - year6_value - year6_value_override - year7_value - year7_value_override - year8_value - year8_value_override - year9_value - year9_value_override - year10_value - year10_value_override - unit_type_id - literal_number - unit_type - is_telemetry_data - function_type_id - abbr - years title: ScratchpadUnit description: Scratchpad Unit model ScratchpadUnitYear: properties: value: type: number title: Value description: The value for the given year key: type: string title: Key description: The key for the year (e.g., year1, year2) override: type: number title: Override description: Override value for the year, if any type: object required: - value - key - override title: ScratchpadUnitYear description: Yearly date for scratchpad unit SearchPayload: properties: search_term: type: string title: Search Term description: The name of the company being searched for type: object required: - search_term title: SearchPayload description: SearchPayload Model SearchRequest: properties: search_term: anyOf: - type: string maxLength: 200 - type: 'null' title: Search Term description: Text to search in VP name and company name include_calcs: type: boolean title: Include Calcs description: Include calculator VPs default: false sort_by: type: string title: Sort By description: Column to sort by default: modified order: type: string enum: - ASC - DESC title: Order description: Sort order (ASC or DESC) default: DESC limit: type: integer maximum: 200.0 minimum: 1.0 title: Limit description: Max results to return default: 25 offset: type: integer minimum: 0.0 title: Offset description: Number of results to skip default: 0 mode: $ref: '#/components/schemas/ListMode' description: 1=Hypothesis, 2=Value Prop, 3=All default: 3 type: object title: SearchRequest description: Request model for searching value propositions. Shares: properties: id: type: integer title: Id description: ID of the value prop share first_name: anyOf: - type: string - type: 'null' title: First Name description: First name of user last_name: anyOf: - type: string - type: 'null' title: Last Name description: Last name of user email: anyOf: - type: string - type: 'null' title: Email description: Email name of user share_role_type_id: anyOf: - type: integer - type: 'null' title: Share Role Type Id description: ID of share role. share_role: anyOf: - type: string - type: 'null' title: Share Role description: User role for the share. type: object required: - id title: Shares description: Model for shares SingleBenefitDetail: properties: id: type: integer title: Id description: The unique identifier for the metric benefit_type_id: anyOf: - type: integer - type: 'null' title: Benefit Type Id description: Benefit type id value_prop_id: type: integer title: Value Prop Id description: The unique identifier for the value proposition account_solution_metric_id: type: integer title: Account Solution Metric Id description: The ID of the solution metric value_category_id: type: integer title: Value Category Id description: The category ID for the value proposition alt_metric_name: anyOf: - type: string - type: 'null' title: Alt Metric Name description: Alternative metric name alt_metric_description: anyOf: - type: string - type: 'null' title: Alt Metric Description description: Alternative metric description metric_note: anyOf: - type: string - type: 'null' title: Metric Note description: General note for the metric metric_note_2: anyOf: - type: string - type: 'null' title: Metric Note 2 description: Second metric note metric_note_2_cf: type: integer title: Metric Note 2 Cf description: Should the note be customer facing metric_note_3: anyOf: - type: string - type: 'null' title: Metric Note 3 description: Third metric note metric_note_3_cf: type: integer title: Metric Note 3 Cf description: Should the note be customer facing driver_estimate: type: number title: Driver Estimate description: Estimated driver value driver_override: type: number title: Driver Override description: Override for the driver value driver_value: type: number title: Driver Value description: Driver value used for the calculation driver_phase_1: type: integer title: Driver Phase 1 description: Phase 1 driver value driver_phase_2: type: integer title: Driver Phase 2 description: Phase 2 driver value driver_phase_3: type: integer title: Driver Phase 3 description: Phase 3 driver value driver_phase_4: type: integer title: Driver Phase 4 description: Phase 4 driver value driver_phase_5: type: integer title: Driver Phase 5 description: Phase 5 driver value driver_phase_6: type: integer title: Driver Phase 6 description: Phase 6 driver value driver_phase_7: type: integer title: Driver Phase 7 description: Phase 7 driver value driver_phase_8: type: integer title: Driver Phase 8 description: Phase 8 driver value driver_phase_9: type: integer title: Driver Phase 9 description: Phase 9 driver value driver_phase_10: type: integer title: Driver Phase 10 description: Phase 10 driver value impact_override: type: number title: Impact Override description: Override for the impact value impact: type: number title: Impact description: Impact value for the metric financial_estimate: type: number title: Financial Estimate description: Financial estimate for the solution financial_override: type: number title: Financial Override description: Override for the financial value financial_value: type: number title: Financial Value description: Final financial value after estimation metric_phase_0: type: number title: Metric Phase 0 description: Metric phasing at year 0 metric_phase_1: type: number title: Metric Phase 1 description: Metric phasing at year 1 metric_phase_2: type: number title: Metric Phase 2 description: Metric phasing at year 2 metric_phase_3: type: number title: Metric Phase 3 description: Metric phasing at year 3 metric_phase_4: type: number title: Metric Phase 4 description: Metric phasing at year 4 metric_phase_5: type: number title: Metric Phase 5 description: Metric phasing at year 5 metric_phase_6: type: number title: Metric Phase 6 description: Metric phasing at year 6 metric_phase_7: type: number title: Metric Phase 7 description: Metric phasing at year 7 metric_phase_8: type: number title: Metric Phase 8 description: Metric phasing at year 8 metric_phase_9: type: number title: Metric Phase 9 description: Metric phasing at year 9 metric_phase_10: type: number title: Metric Phase 10 description: Metric phasing at year 10 active: type: integer title: Active description: Flag indicating the active status features: anyOf: - type: string - type: 'null' title: Features description: Features of the metric year1_benefits: type: number title: Year1 Benefits description: Benefits from the first year year2_benefits: type: number title: Year2 Benefits description: Benefits from the second year year3_benefits: type: number title: Year3 Benefits description: Benefits from the third year year4_benefits: type: number title: Year4 Benefits description: Benefits from the fourth year default: 0 year5_benefits: type: number title: Year5 Benefits description: Benefits from the fifth year default: 0 year6_benefits: type: number title: Year6 Benefits description: Benefits from the sixth year default: 0 year7_benefits: type: number title: Year7 Benefits description: Benefits from the seventh year default: 0 year8_benefits: type: number title: Year8 Benefits description: Benefits from the eighth year default: 0 year9_benefits: type: number title: Year9 Benefits description: Benefits from the ninth year default: 0 year10_benefits: type: number title: Year10 Benefits description: Benefits from the tenth year default: 0 total_benefits: type: number title: Total Benefits description: Total benefits from all years metric_name: type: string title: Metric Name description: Name of the metric description: type: string title: Description description: Description of the metric improvement_factor_id: type: integer title: Improvement Factor Id description: ID of the improvement factor driver_factor_id: type: integer title: Driver Factor Id description: ID of the driver factor driver_baseline_answer: type: number title: Driver Baseline Answer description: Baseline answer for the driver financial_factor_id: type: integer title: Financial Factor Id description: ID of the financial factor financial_baseline_answer: type: number title: Financial Baseline Answer description: Baseline answer for the financial factor note_2_label: type: string title: Note 2 Label description: Label for note 2 note_3_label: type: string title: Note 3 Label description: Label for note 3 d_precision: type: integer title: D Precision description: Precision of the driver factor d_literal_number: type: integer title: D Literal Number description: Is the driver factor a fixed number f_precision: type: integer title: F Precision description: Precision of the financial factor f_literal_number: type: integer title: F Literal Number description: Is the financial factor a fixed number i_precision: type: integer title: I Precision description: Precision of the impact factor i_literal_number: type: integer title: I Literal Number description: Is the improvement factor a fixed number d_unit_type_id: type: integer title: D Unit Type Id description: Unit type ID for the driver factor f_unit_type_id: type: integer title: F Unit Type Id description: Unit type ID for the financial factor i_unit_type_id: type: integer title: I Unit Type Id description: Unit type ID for the impact factor d_abbr: anyOf: - type: string - type: 'null' title: D Abbr description: Abbreviation for the driver factor f_abbr: anyOf: - type: string - type: 'null' title: F Abbr description: Abbreviation for the financial factor abbr: anyOf: - type: string - type: 'null' title: Abbr description: Abbreviation for the metric improvement_factor: type: string title: Improvement Factor description: Description of the improvement factor value_category: type: string title: Value Category description: Category of the value proposition driver_factor: type: string title: Driver Factor description: Description of the driver factor financial_factor: type: string title: Financial Factor description: Description of the financial factor i_abbr: anyOf: - type: string - type: 'null' title: I Abbr description: Abbreviation for the impact factor driver_description: anyOf: - type: string - type: 'null' title: Driver Description description: Description of the driver financial_description: anyOf: - type: string - type: 'null' title: Financial Description description: Description of the financial factor value_prop_metric_id: type: integer title: Value Prop Metric Id description: ID of the value proposition metric vp_case_studies: type: integer title: Vp Case Studies description: Denotes whether the metric has a case study has_driver_scratchpad: type: integer title: Has Driver Scratchpad description: Flag if the driver scratchpad is available driver_scratchpad_used: type: integer title: Driver Scratchpad Used description: Flag if the driver scratchpad is being used has_financial_scratchpad: type: integer title: Has Financial Scratchpad description: Flag if the financial scratchpad is available financial_scratchpad_used: type: integer title: Financial Scratchpad Used description: Flag if the financial scratchpad is being used has_improvement_scratchpad: type: integer title: Has Improvement Scratchpad description: Flag if the improvement scratchpad is available improvement_scratchpad_used: type: integer title: Improvement Scratchpad Used description: Flag if the improvement scratchpad is being used impact_fmt: type: string title: Impact Fmt description: Formatted impact value driver_value_fmt: type: string title: Driver Value Fmt description: Formatted driver value driver_value_fr: type: number title: Driver Value Fr description: Formatted driver value financial_value_fmt: type: string title: Financial Value Fmt description: Formatted financial value financial_value_fr: type: number title: Financial Value Fr description: Formatted financial value year1_driver: anyOf: - type: number - type: 'null' title: Year1 Driver description: Driver value for the first year default: 0 year1_improvement: anyOf: - type: number - type: 'null' title: Year1 Improvement description: Improvement factor for the first year default: 0 year1_financial: anyOf: - type: number - type: 'null' title: Year1 Financial description: Financial value for the first year default: 0 year1_benefits_fmt: type: string title: Year1 Benefits Fmt description: Formatted benefits for the first year year1_benefits_fr: type: number title: Year1 Benefits Fr description: Formatted benefits for the first year monthly: type: number title: Monthly description: Monthly benefits year2_driver: anyOf: - type: number - type: 'null' title: Year2 Driver description: Driver value for the second year default: 0 year2_improvement: anyOf: - type: number - type: 'null' title: Year2 Improvement description: Improvement factor for the second year default: 0 year2_financial: anyOf: - type: number - type: 'null' title: Year2 Financial description: Financial value for the second year default: 0 year2_benefits_fmt: type: string title: Year2 Benefits Fmt description: Formatted benefits for the second year year2_benefits_fr: type: number title: Year2 Benefits Fr description: Formatted benefits for the second year year3_driver: anyOf: - type: number - type: 'null' title: Year3 Driver description: Driver value for the third year default: 0 year3_improvement: anyOf: - type: number - type: 'null' title: Year3 Improvement description: Improvement factor for the third year default: 0 year3_financial: anyOf: - type: number - type: 'null' title: Year3 Financial description: Financial value for the third year default: 0 year3_benefits_fmt: type: string title: Year3 Benefits Fmt description: Formatted benefits for the third year year3_benefits_fr: type: number title: Year3 Benefits Fr description: Formatted benefits for the third year year4_driver: anyOf: - type: number - type: 'null' title: Year4 Driver description: Driver value for the fourth year default: 0 year4_improvement: anyOf: - type: number - type: 'null' title: Year4 Improvement description: Improvement factor for the fourth year default: 0 year4_financial: anyOf: - type: number - type: 'null' title: Year4 Financial description: Financial value for the fourth year default: 0 year4_benefits_fmt: type: string title: Year4 Benefits Fmt description: Formatted benefits for the fourth year default: 0 year4_benefits_fr: type: number title: Year4 Benefits Fr description: Formatted benefits for the fourth year default: 0 year5_driver: anyOf: - type: number - type: 'null' title: Year5 Driver description: Driver value for the fifth year default: 0 year5_improvement: anyOf: - type: number - type: 'null' title: Year5 Improvement description: Improvement factor for the fifth year default: 0 year5_financial: anyOf: - type: number - type: 'null' title: Year5 Financial description: Financial value for the fifth year default: 0 year5_benefits_fmt: type: string title: Year5 Benefits Fmt description: Formatted benefits for the fifth year default: 0 year5_benefits_fr: type: number title: Year5 Benefits Fr description: Formatted benefits for the fifth year default: 0 year6_driver: anyOf: - type: number - type: 'null' title: Year6 Driver description: Driver value for the sixth year default: 0 year6_improvement: anyOf: - type: number - type: 'null' title: Year6 Improvement description: Improvement factor for the sixth year default: 0 year6_financial: anyOf: - type: number - type: 'null' title: Year6 Financial description: Financial value for the sixth year default: 0 year6_benefits_fmt: type: string title: Year6 Benefits Fmt description: Formatted benefits for the sixth year default: 0 year6_benefits_fr: type: number title: Year6 Benefits Fr description: Formatted benefits for the sixth year default: 0 year7_driver: anyOf: - type: number - type: 'null' title: Year7 Driver description: Driver value for the seventh year default: 0 year7_improvement: anyOf: - type: number - type: 'null' title: Year7 Improvement description: Improvement factor for the seventh year default: 0 year7_financial: anyOf: - type: number - type: 'null' title: Year7 Financial description: Financial value for the seventh year default: 0 year7_benefits_fmt: type: string title: Year7 Benefits Fmt description: Formatted benefits for the seventh year default: 0 year7_benefits_fr: type: number title: Year7 Benefits Fr description: Formatted benefits for the seventh year default: 0 year8_driver: anyOf: - type: number - type: 'null' title: Year8 Driver description: Driver value for the eighth year default: 0 year8_improvement: anyOf: - type: number - type: 'null' title: Year8 Improvement description: Improvement factor for the eighth year default: 0 year8_financial: anyOf: - type: number - type: 'null' title: Year8 Financial description: Financial value for the eighth year default: 0 year8_benefits_fmt: type: string title: Year8 Benefits Fmt description: Formatted benefits for the eighth year default: 0 year8_benefits_fr: type: number title: Year8 Benefits Fr description: Formatted benefits for the eighth year default: 0 year9_driver: anyOf: - type: number - type: 'null' title: Year9 Driver description: Driver value for the ninth year default: 0 year9_improvement: anyOf: - type: number - type: 'null' title: Year9 Improvement description: Improvement factor for the ninth year default: 0 year9_financial: anyOf: - type: number - type: 'null' title: Year9 Financial description: Financial value for the ninth year default: 0 year9_benefits_fmt: type: string title: Year9 Benefits Fmt description: Formatted benefits for the ninth year default: 0 year9_benefits_fr: type: number title: Year9 Benefits Fr description: Formatted benefits for the ninth year default: 0 year10_driver: anyOf: - type: number - type: 'null' title: Year10 Driver description: Driver value for the tenth year default: 0 year10_improvement: anyOf: - type: number - type: 'null' title: Year10 Improvement description: Improvement factor for the tenth year default: 0 year10_financial: anyOf: - type: number - type: 'null' title: Year10 Financial description: Financial value for the tenth year default: 0 year10_benefits_fmt: type: string title: Year10 Benefits Fmt description: Formatted benefits for the tenth year default: 0 year10_benefits_fr: type: number title: Year10 Benefits Fr description: Formatted benefits for the tenth year default: 0 type: object required: - id - value_prop_id - account_solution_metric_id - value_category_id - metric_note_2_cf - metric_note_3_cf - driver_estimate - driver_override - driver_value - driver_phase_1 - driver_phase_2 - driver_phase_3 - driver_phase_4 - driver_phase_5 - driver_phase_6 - driver_phase_7 - driver_phase_8 - driver_phase_9 - driver_phase_10 - impact_override - impact - financial_estimate - financial_override - financial_value - metric_phase_0 - metric_phase_1 - metric_phase_2 - metric_phase_3 - metric_phase_4 - metric_phase_5 - metric_phase_6 - metric_phase_7 - metric_phase_8 - metric_phase_9 - metric_phase_10 - active - year1_benefits - year2_benefits - year3_benefits - total_benefits - metric_name - description - improvement_factor_id - driver_factor_id - driver_baseline_answer - financial_factor_id - financial_baseline_answer - note_2_label - note_3_label - d_precision - d_literal_number - f_precision - f_literal_number - i_precision - i_literal_number - d_unit_type_id - f_unit_type_id - i_unit_type_id - improvement_factor - value_category - driver_factor - financial_factor - value_prop_metric_id - vp_case_studies - has_driver_scratchpad - driver_scratchpad_used - has_financial_scratchpad - financial_scratchpad_used - has_improvement_scratchpad - improvement_scratchpad_used - impact_fmt - driver_value_fmt - driver_value_fr - financial_value_fmt - financial_value_fr - year1_benefits_fmt - year1_benefits_fr - monthly - year2_benefits_fmt - year2_benefits_fr - year3_benefits_fmt - year3_benefits_fr title: SingleBenefitDetail description: Single Benefit Detail model Situation: properties: id: type: string title: Id description: ID for the Situation name: type: string title: Name description: Name of the Situation description: anyOf: - type: string - type: 'null' title: Description description: Description of the Situation default: '' multi_select: type: boolean title: Multi Select description: Multi-select status of the Situation question_type: type: string title: Question Type description: Question type of the Situation required: type: boolean title: Required description: Required status of the Situation elements: items: $ref: '#/components/schemas/Element' type: array title: Elements description: Elements of the Situation source_attribution: anyOf: - type: string - type: 'null' title: Source Attribution attribution_link: anyOf: - type: string - type: 'null' title: Attribution Link attribution_tooltip: anyOf: - type: string - type: 'null' title: Attribution Tooltip revert_value: anyOf: - type: string - type: 'null' title: Revert Value type: object required: - id - name - multi_select - question_type - required - elements title: Situation description: Situation model SituationPayload: properties: situations: items: $ref: '#/components/schemas/SituationValue' type: array title: Situations description: The list of situations to being saved type: object required: - situations title: SituationPayload description: SituationPayload model SituationValue: properties: id: type: string title: Id description: Situation ID element_id: type: string title: Element Id description: Situation Element ID type: object required: - id - element_id title: SituationValue description: SituationValue model SolutionSelection: properties: solutions: items: type: integer type: array title: Solutions description: List of selected solution IDs type: object required: - solutions title: SolutionSelection description: SolutionSelection model for submitting selected solutions. SolutionsPayload: properties: solutions: items: type: integer type: array title: Solutions type: object required: - solutions title: SolutionsPayload description: SolutionsPayload Model ThresholdStatus: properties: id: type: integer title: Id description: Threshold type ID name: type: string title: Name description: Threshold type name description: type: string title: Description description: Threshold type description keyword: type: string title: Keyword description: Keyword for value mapping operation: type: string title: Operation description: Operation type status: type: string title: Status description: Status name status_id: type: integer title: Status Id description: Status ID min_threshold: type: number title: Min Threshold description: Minimum threshold value max_threshold: type: number title: Max Threshold description: Maximum threshold value margin_threshold: type: number title: Margin Threshold description: Margin threshold value current_value: anyOf: - type: number - type: 'null' title: Current Value description: Current calculated value type: object required: - id - name - description - keyword - operation - status - status_id - min_threshold - max_threshold - margin_threshold title: ThresholdStatus description: Threshold status response model Translation: properties: id: type: integer title: Id description: Translation identifier. component: type: string title: Component description: Component key. lang: type: string title: Lang description: Two-letter language code. key: type: string title: Key description: Translation key. val: type: string title: Val description: Translated value. type: object required: - id - component - lang - key - val title: Translation description: Translation string model. TranslationComponent: properties: id: type: integer title: Id description: Unique identifier. display_name: type: string title: Display Name description: Display name of the component. component: type: string title: Component description: Component key. description: type: string title: Description description: Description of the component. default: '' type: object required: - id - display_name - component title: TranslationComponent description: Translation component model. TranslationWithOverride: properties: translation_id: type: integer title: Translation Id description: Unique translation identifier. key: type: string title: Key description: Translation key. value: type: string title: Value description: Resolved translation value (override or base). is_override: type: integer title: Is Override description: 1 when an account override was applied, 0 otherwise. type: object required: - translation_id - key - value - is_override title: TranslationWithOverride description: Translation row with optional account override applied. TriggerSettingsPayload: properties: trigger_stages: items: type: string type: array title: Trigger Stages default: [] trigger_types: items: type: string type: array title: Trigger Types default: [] type: object title: TriggerSettingsPayload description: Payload for updating trigger stage and type settings TriggerSettingsResponse: properties: trigger_stages: items: type: string type: array title: Trigger Stages trigger_types: items: type: string type: array title: Trigger Types default: [] type: object required: - trigger_stages title: TriggerSettingsResponse description: Response for trigger stage and type settings UnitType: properties: id: type: integer title: Id description: ID for the Unit Type name: type: string title: Name description: Name of the Unit Type abbreviation: anyOf: - type: string - type: 'null' title: Abbreviation description: Abbreviation for the Unit Type type: object required: - id - name - abbreviation title: UnitType description: UnitType model UpdateCollaboration: properties: expires: type: string format: date-time title: Expires benefits_editable: type: integer title: Benefits Editable assumptions_editable: type: integer title: Assumptions Editable account_asset_template_id: type: integer title: Account Asset Template Id discovery_questions_enabled: type: integer title: Discovery Questions Enabled type: object required: - expires - benefits_editable - assumptions_editable - account_asset_template_id - discovery_questions_enabled title: UpdateCollaboration description: Model for updating a collaboration UpdateDriverPhasingPayload: properties: value_prop_metric_id: anyOf: - type: integer - type: string title: Value Prop Metric Id description: The ID for the value proposition metric driver_phase_2: anyOf: - type: integer - type: 'null' title: Driver Phase 2 description: The value for driver phase 2 driver_phase_3: anyOf: - type: integer - type: 'null' title: Driver Phase 3 description: The value for driver phase 3 driver_phase_4: anyOf: - type: integer - type: 'null' title: Driver Phase 4 description: The value for driver phase 4 driver_phase_5: anyOf: - type: integer - type: 'null' title: Driver Phase 5 description: The value for driver phase 5 driver_phase_6: anyOf: - type: integer - type: 'null' title: Driver Phase 6 description: The value for driver phase 6 driver_phase_7: anyOf: - type: integer - type: 'null' title: Driver Phase 7 description: The value for driver phase 7 driver_phase_8: anyOf: - type: integer - type: 'null' title: Driver Phase 8 description: The value for driver phase 8 driver_phase_9: anyOf: - type: integer - type: 'null' title: Driver Phase 9 description: The value for driver phase 9 driver_phase_10: anyOf: - type: integer - type: 'null' title: Driver Phase 10 description: The value for driver phase 10 type: object required: - value_prop_metric_id title: UpdateDriverPhasingPayload description: UpdateDriverPhasingPayload model UpdateShare: properties: share_role_type_id: type: integer title: Share Role Type Id description: Id for the share role type type: object required: - share_role_type_id title: UpdateShare description: Model for updating a share UpdateValuePropPayload: properties: company_id: anyOf: - type: integer - type: 'null' title: Company Id description: ID of the Company for the ValueProp name: anyOf: - type: string - type: 'null' title: Name description: Name of the Value Proposition type: object title: UpdateValuePropPayload description: UpdateValuePropPayload model User: properties: id: type: integer title: Id description: Unique identifier for the user email: type: string title: Email description: Email address of the user first_name: type: string title: First Name description: First name of the user last_name: type: string title: Last Name description: Last name of the user type: object required: - id - email - first_name - last_name title: User description: User Response Model VPGroupResult: properties: value_prop_groups: items: $ref: '#/components/schemas/ExternalVPGroup' type: array title: Value Prop Groups type: object required: - value_prop_groups title: VPGroupResult Validation: properties: id: type: integer title: Id value_prop_id: type: integer title: Value Prop Id account_factor_id: type: integer title: Account Factor Id user_id: anyOf: - type: integer - type: 'null' title: User Id validating_user_name: anyOf: - type: string - type: 'null' title: Validating User Name previous_val: anyOf: - type: integer - type: number - type: 'null' title: Previous Val new_val: anyOf: - type: integer - type: number - type: 'null' title: New Val year: anyOf: - type: integer - type: 'null' title: Year date: anyOf: - type: string format: date-time - type: 'null' title: Date type: object required: - id - value_prop_id - account_factor_id - user_id - validating_user_name - previous_val - new_val - year - date title: Validation description: Factor Validation Model ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError ValueCategory: properties: id: type: string title: Id description: ID for the Value Category name: type: string title: Name description: Name of the Value Category description: type: string title: Description description: Description of the Value Category benefits: items: $ref: '#/components/schemas/value_proposition__benefits__models__Benefit' type: array title: Benefits description: Benefits belonging to the Value Category year1_benefits: type: number title: Year1 Benefits description: Year 1 benefits year2_benefits: type: number title: Year2 Benefits description: Year 2 benefits year3_benefits: type: number title: Year3 Benefits description: Year 3 benefits year4_benefits: type: number title: Year4 Benefits description: Year 4 benefits year5_benefits: type: number title: Year5 Benefits description: Year 5 benefits year6_benefits: type: number title: Year6 Benefits description: Year 6 benefits year7_benefits: type: number title: Year7 Benefits description: Year 7 benefits year8_benefits: type: number title: Year8 Benefits description: Year 8 benefits year9_benefits: type: number title: Year9 Benefits description: Year 9 benefits year10_benefits: type: number title: Year10 Benefits description: Year 10 benefits total_benefits: type: number title: Total Benefits description: Total benefits vc_dif_total: type: number title: Vc Dif Total description: Sum of year-1 differential (driver_value * impact * financial_value) across active metrics in this group default: 0.0 type: object required: - id - name - description - benefits - year1_benefits - year2_benefits - year3_benefits - year4_benefits - year5_benefits - year6_benefits - year7_benefits - year8_benefits - year9_benefits - year10_benefits - total_benefits title: ValueCategory description: ValueCategory model ValueProp: properties: id: type: integer title: Id description: ID of the ValueProp name: type: string title: Name description: Name of the ValueProp company_id: type: string title: Company Id description: CompanyID of the ValueProp company_name: type: string title: Company Name description: Company Name of the ValueProp opportunity_id: anyOf: - type: string - type: 'null' title: Opportunity Id description: Opportunity ID of the ValueProp term: type: integer title: Term description: Term of the ValueProp in Years baseline_type_id: type: integer title: Baseline Type Id description: Baseline Type of the ValueProp currency_type_id: type: integer title: Currency Type Id description: Currency Type of the ValueProp language_type_id: type: integer title: Language Type Id description: Language Type of the ValueProp total_benefits: type: number title: Total Benefits description: Total Benefits of the ValueProp total_benefits_fmt: anyOf: - type: string - type: 'null' title: Total Benefits Fmt total_costs: type: number title: Total Costs description: Total Costs of the ValueProp total_costs_fmt: anyOf: - type: string - type: 'null' title: Total Costs Fmt cost_of_delay: type: number title: Cost Of Delay description: Cost of Delay for the ValueProp cost_of_delay_fmt: type: string title: Cost Of Delay Fmt description: Formatted Cost of Delay for the ValueProp net_cashflow_fmt: type: string title: Net Cashflow Fmt description: Formatted net cash flow gross_profit: type: number title: Gross Profit description: Gross Profit of the ValueProp irr: type: number title: Irr description: IRR of the ValueProp npv: type: number title: Npv description: Net Present Value of the ValueProp npv_fmt: type: string title: Npv Fmt description: Formatted Net Present Value of the ValueProp payback: type: number title: Payback description: Payback Period of the ValueProp roi: type: number title: Roi description: Return on Investment of the ValueProp roi_range: type: number title: Roi Range description: Return on Investment Range of the ValueProp roi_decorated: type: string title: Roi Decorated description: Return on decorated Investment Range of the ValueProp tco: type: number title: Tco description: Total Cost of Ownership of the ValueProp wacc: type: number title: Wacc description: Weighted Average Cost of Capital of the ValueProp closed: type: integer title: Closed description: Closed Status of the ValueProp status: type: string title: Status description: Status of the ValueProp status_id: type: integer title: Status Id description: Status ID of the ValueProp url: anyOf: - type: string - type: 'null' title: Url description: URL of the ValueProp solutions_display: anyOf: - type: string - type: 'null' title: Solutions Display description: Original display of ValueProp Solutions xf_solutions_display: anyOf: - type: string - type: 'null' title: Xf Solutions Display description: XF specific display of ValueProp Solutions created_at: anyOf: - type: string - type: 'null' title: Created At description: Date when the ValueProp was created created_by: anyOf: - type: string - type: 'null' title: Created By description: Name of User who created the ValueProp created_by_email: anyOf: - type: string - type: 'null' title: Created By Email description: Email of User who created the ValueProp updated_at: anyOf: - type: string - type: 'null' title: Updated At description: Date when the ValueProp was last updated updated_by: anyOf: - type: string - type: 'null' title: Updated By description: Name of User who last updated the ValueProp updated_by_email: anyOf: - type: string - type: 'null' title: Updated By Email description: Email of User who last updated the ValueProp done: anyOf: - type: integer - type: 'null' title: Done description: Done flag default: 0 scenario_done: anyOf: - type: integer - type: 'null' title: Scenario Done description: Scenario done flag default: 0 situation_done: anyOf: - type: integer - type: 'null' title: Situation Done description: Situation done flag default: 0 scalers_done: anyOf: - type: integer - type: 'null' title: Scalers Done description: Scalers done flag default: 0 key_data_done: anyOf: - type: integer - type: 'null' title: Key Data Done description: Key Data done flag review_benefits_done: anyOf: - type: integer - type: 'null' title: Review Benefits Done description: Review Benefits data done flag customer_investment_done: anyOf: - type: integer - type: 'null' title: Customer Investment Done description: Customer Investment done flag custom_value_realized_date: anyOf: - type: string - type: 'null' title: Custom Value Realized Date description: Custom value realized date npv_formula: anyOf: - type: string - type: 'null' title: Npv Formula description: Formula with values for npv npv_formula_text: anyOf: - type: string - type: 'null' title: Npv Formula Text description: Formula with names for npv net_cashflow_formula: anyOf: - type: string - type: 'null' title: Net Cashflow Formula description: Formula with values for net cashflow net_cashflow_formula_text: type: string title: Net Cashflow Formula Text description: Formula with names for net cashflow payback_data: anyOf: - $ref: '#/components/schemas/PaybackChart' - type: 'null' cost_of_delay_data: anyOf: - $ref: '#/components/schemas/CostOfDelay' - type: 'null' user_id: anyOf: - type: integer - type: 'null' title: User Id solutions: anyOf: - items: $ref: '#/components/schemas/ValuePropSolution' type: array - type: 'null' title: Solutions description: List of solutions year1_benefits: anyOf: - type: number - type: 'null' title: Year1 Benefits description: Year 1 benefits year2_benefits: anyOf: - type: number - type: 'null' title: Year2 Benefits description: Year 2 benefits year3_benefits: anyOf: - type: number - type: 'null' title: Year3 Benefits description: Year 3 benefits year4_benefits: anyOf: - type: number - type: 'null' title: Year4 Benefits description: Year 4 benefits year5_benefits: anyOf: - type: number - type: 'null' title: Year5 Benefits description: Year 5 benefits year6_benefits: anyOf: - type: number - type: 'null' title: Year6 Benefits description: Year 6 benefits year7_benefits: anyOf: - type: number - type: 'null' title: Year7 Benefits description: Year 7 benefits year8_benefits: anyOf: - type: number - type: 'null' title: Year8 Benefits description: Year 8 benefits year9_benefits: anyOf: - type: number - type: 'null' title: Year9 Benefits description: Year 9 benefits year10_benefits: anyOf: - type: number - type: 'null' title: Year10 Benefits description: Year 10 benefits year1_costs: anyOf: - type: number - type: 'null' title: Year1 Costs description: Year 1 costs year2_costs: anyOf: - type: number - type: 'null' title: Year2 Costs description: Year 2 costs year3_costs: anyOf: - type: number - type: 'null' title: Year3 Costs description: Year 3 costs year4_costs: anyOf: - type: number - type: 'null' title: Year4 Costs description: Year 4 costs year5_costs: anyOf: - type: number - type: 'null' title: Year5 Costs description: Year 5 costs year6_costs: anyOf: - type: number - type: 'null' title: Year6 Costs description: Year 6 costs year7_costs: anyOf: - type: number - type: 'null' title: Year7 Costs description: Year 7 costs year8_costs: anyOf: - type: number - type: 'null' title: Year8 Costs description: Year 8 costs year9_costs: anyOf: - type: number - type: 'null' title: Year9 Costs description: Year 9 costs year10_costs: anyOf: - type: number - type: 'null' title: Year10 Costs description: Year 10 costs value_prop_status: anyOf: - type: integer - type: 'null' title: Value Prop Status description: Value proposition status creation_source: anyOf: - type: string - type: 'null' title: Creation Source description: Source that originated the Value Proposition creation default: user type: object required: - id - name - company_id - company_name - term - baseline_type_id - currency_type_id - language_type_id - total_benefits - total_costs - cost_of_delay - cost_of_delay_fmt - net_cashflow_fmt - gross_profit - irr - npv - npv_fmt - payback - roi - roi_range - roi_decorated - tco - wacc - closed - status - status_id title: ValueProp description: ValueProp model ValuePropAdvanced: properties: value_prop_id: anyOf: - type: integer - type: 'null' title: Value Prop Id description: The ID of the value proposition baseline_type_id: anyOf: - type: integer - type: 'null' title: Baseline Type Id description: The baseline type ID baseline_type: anyOf: - type: string - type: 'null' title: Baseline Type description: The baseline type description term: anyOf: - type: integer - type: 'null' title: Term description: The term for the value proposition conversion_rate: anyOf: - type: number - type: 'null' title: Conversion Rate description: The conversion rate roi_range: anyOf: - type: integer - type: 'null' title: Roi Range description: The ROI range currency_type_id: anyOf: - type: integer - type: 'null' title: Currency Type Id description: The currency type ID currency_types: anyOf: - items: $ref: '#/components/schemas/CurrencyType' type: array - type: 'null' title: Currency Types description: List of available currency types number_format_types: anyOf: - items: $ref: '#/components/schemas/NumberFormatType' type: array - type: 'null' title: Number Format Types description: List of available number format types number_format: anyOf: - type: integer - type: 'null' title: Number Format description: The selected number format wacc: anyOf: - type: number - type: 'null' title: Wacc description: The weighted average cost of capital (WACC) gross_profit: anyOf: - type: number - type: 'null' title: Gross Profit description: The gross profit deployment_time: anyOf: - type: integer - type: 'null' title: Deployment Time description: Deployment time opportunity_id: anyOf: - type: string - type: 'null' title: Opportunity Id description: Opportunity ID language_type_id: anyOf: - type: integer - type: 'null' title: Language Type Id description: Language Type ID type: object title: ValuePropAdvanced description: Model representing the advanced details of a value proposition. ValuePropAdvancedPayload: properties: baseline_type_id: type: integer title: Baseline Type Id description: The baseline type ID customer_type_id: anyOf: - type: integer - type: 'null' title: Customer Type Id description: The customer type ID default: 1 deployment_time: type: integer title: Deployment Time description: The deployment time gross_profit: anyOf: - type: number - type: 'null' title: Gross Profit description: The gross profit default: 0 currency_type_id: type: number title: Currency Type Id description: The currency type ID number_format: type: integer title: Number Format description: The selected number format conversion_rate: type: number title: Conversion Rate description: The conversion rate term: type: integer title: Term description: The term duration language_type_id: anyOf: - type: integer - type: 'null' title: Language Type Id description: The language type ID wacc: anyOf: - type: number - type: 'null' title: Wacc description: The weighted average cost of capital (WACC) opportunity_id: anyOf: - type: string - type: 'null' title: Opportunity Id description: The opportunity ID type: object required: - baseline_type_id - deployment_time - currency_type_id - number_format - conversion_rate - term title: ValuePropAdvancedPayload description: Model representing the advanced details of a value proposition payload. ValuePropROIChart: properties: roi_chart: $ref: '#/components/schemas/ROIChart' type: object required: - roi_chart title: ValuePropROIChart description: Model for Value Proposition ROI Chart ValuePropResult: properties: value_props: items: $ref: '#/components/schemas/ExternalVP' type: array title: Value Props type: object required: - value_props title: ValuePropResult ValuePropSolution: properties: id: type: integer title: Id description: ID of the Solution value_prop_id: type: integer title: Value Prop Id description: Value Prop ID of the Solution account_solution_id: type: integer title: Account Solution Id description: Account Solution ID of the Solution quantity: type: integer title: Quantity description: Quantity of the Solution deployment_time: type: integer title: Deployment Time description: Deployment time of the Solution created: type: string title: Created description: Creation date of the Solution modified: type: string title: Modified description: Modification date of the Solution name: type: string title: Name description: Name of the Solution description: type: string title: Description description: Description of the Solution quantity_enabled: type: integer title: Quantity Enabled description: Quantity enabled flag of the Solution type: object required: - id - value_prop_id - account_solution_id - quantity - deployment_time - created - modified - name - description - quantity_enabled title: ValuePropSolution description: ValueProp Solution model ValuePropVCChart: properties: names: items: $ref: '#/components/schemas/BenefitCategory' type: array title: Names description: Benefit categories with their associated metrics total_benefits: items: type: string type: array title: Total Benefits description: List of total benefits values (raw) total_benefits_fmt: items: type: string type: array title: Total Benefits Fmt description: List of formatted total benefits values total_benefits_fr: items: type: string type: array title: Total Benefits Fr description: List of total benefits values in French format percents: items: type: number type: array title: Percents description: List of percentage values total_annual_benefits: type: string title: Total Annual Benefits description: Total annual benefits (raw) total_annual_benefits_fmt: type: string title: Total Annual Benefits Fmt description: Formatted total annual benefits type: object required: - names - total_benefits - total_benefits_fmt - total_benefits_fr - percents - total_annual_benefits - total_annual_benefits_fmt title: ValuePropVCChart description: Overall VC chart model. ValueRealizationGoal: properties: id: type: integer title: Id description: The Value Prop Goal ID value_prop_id: type: integer title: Value Prop Id description: The Value Proposition ID account_factor_id: type: integer title: Account Factor Id description: The Account Factor ID function_type_id: type: integer title: Function Type Id description: The Function Type ID factor_estimate: type: number title: Factor Estimate description: Factor estimate value factor_override: type: number title: Factor Override description: Factor override value situation_override: type: number title: Situation Override description: Situation override value value: type: number title: Value description: The Goal's value source_type_id: type: integer title: Source Type Id description: The source of the Goal's value baseline_value: type: number title: Baseline Value description: The baseline value for the Goal active: type: integer title: Active description: Flag indicating whether the Goal is active created: type: string format: date-time title: Created description: Timestamp when the record was created modified: type: string format: date-time title: Modified description: Timestamp when the record was last modified capture_baseline: type: boolean title: Capture Baseline description: Flag indicating whether to capture baseline values capture_target: type: boolean title: Capture Target description: Flag indicating whether to capture target values vr_normalized: type: boolean title: Vr Normalized description: Flag indicating whether the Goal value should be normalized in Value Realizations value_realization_name: type: string title: Value Realization Name description: Fallback name from account aggregation vr_override_name: anyOf: - type: string - type: 'null' title: Vr Override Name description: Override name if set has_scratchpad: type: boolean title: Has Scratchpad description: Flag indicating whether the Goal has a scratchpad name: type: string title: Name description: Final chosen name for this goal category_id: anyOf: - type: integer - type: 'null' title: Category Id default: 0 category_name: anyOf: - type: string - type: 'null' title: Category Name default: '' category_description: anyOf: - type: string - type: 'null' title: Category Description default: '' type: object required: - id - value_prop_id - account_factor_id - function_type_id - factor_estimate - factor_override - situation_override - value - source_type_id - baseline_value - active - created - modified - capture_baseline - capture_target - vr_normalized - value_realization_name - has_scratchpad - name title: ValueRealizationGoal description: Detailed Value Realization Goal Model ValueRealizationGoalGroup: properties: category_id: type: integer title: Category Id description: Factor category ID category_name: type: string title: Category Name description: Factor category name category_description: anyOf: - type: string - type: 'null' title: Category Description description: Factor category description default: '' goals: items: $ref: '#/components/schemas/ValueRealizationGoal' type: array title: Goals type: object required: - category_id - category_name - goals title: ValueRealizationGoalGroup description: Value Realization Group Group Model ValueRealizationGoalUpdate: properties: id: type: integer title: Id description: The Value Prop Goal ID to update baseline_value: type: number title: Baseline Value description: New baseline value (defaults to 0) default: 0 value: type: number title: Value description: New target value (defaults to 0) default: 0 active: type: integer title: Active description: Whether this goal is active (0 or 1) default: 0 type: object required: - id title: ValueRealizationGoalUpdate description: Value Realization Goal Update Model Workflow: properties: id: type: integer title: Id description: The ID of the workflow account_id: type: integer title: Account Id description: The account_id for the account of the workflow user_id: anyOf: - type: integer - type: 'null' title: User Id description: The user who created the workflow default: 0 sequence: type: integer title: Sequence description: The sequence of the workflow workflow_type_id: type: integer title: Workflow Type Id description: The workflow type name: type: string title: Name description: The name of the workflow description: type: string title: Description description: The description of the workflow icon: type: string title: Icon description: The icon associated with the workflow active: type: integer title: Active description: A flag indicating whether the workflow is active or not system_defined: type: integer title: System Defined description: A flag indicating whether the workflow is system-defined or user-defined all_templates: type: integer title: All Templates description: A flag indicating whether all templates are included in the workflow all_users: type: integer title: All Users description: A flag indicating whether all users should have access to the workflow default_assignment: type: integer title: Default Assignment description: The default assignment for the workflow, if applicable show_ai_pills: type: integer title: Show Ai Pills description: A flag indicating whether AI pills should be shown default: 0 conversations: anyOf: - items: $ref: '#/components/schemas/ConversationMember' type: array - type: 'null' title: Conversations description: A list of conversations associated with the workflow type: object required: - id - account_id - sequence - workflow_type_id - name - description - icon - active - system_defined - all_templates - all_users - default_assignment title: Workflow description: Workflow Model value_proposition__benefits__models__Benefit: properties: id: type: string title: Id description: ID for the Benefit name: type: string title: Name description: Name of the Benefit description: type: string title: Description description: Description of the Benefit active: type: string title: Active description: Active status of the Benefit tracker_active: anyOf: - type: integer - type: 'null' title: Tracker Active description: Active status of benefit tracker driver_value: anyOf: - type: string - type: integer - type: number - type: 'null' title: Driver Value description: Formatted driver value financial_value: anyOf: - type: string - type: 'null' title: Financial Value description: Formatted driver value impact: anyOf: - type: string - type: integer - type: number - type: 'null' title: Impact description: Formatted driver value driver_value_fmt: anyOf: - type: string - type: 'null' title: Driver Value Fmt description: Formatted driver value driver_value_p2: anyOf: - type: string - type: 'null' title: Driver Value P2 description: Formatted driver value driver_value_fr: anyOf: - type: string - type: 'null' title: Driver Value Fr description: Formatted driver value financial_value_fmt: anyOf: - type: string - type: 'null' title: Financial Value Fmt description: Formatted financial value financial_value_p2: anyOf: - type: string - type: 'null' title: Financial Value P2 description: Formatted financial value financial_value_fr: anyOf: - type: string - type: 'null' title: Financial Value Fr description: Formatted financial value year1_benefits: type: number title: Year1 Benefits description: Year 1 benefits year2_benefits: type: number title: Year2 Benefits description: Year 2 benefits year3_benefits: type: number title: Year3 Benefits description: Year 3 benefits year4_benefits: type: number title: Year4 Benefits description: Year 4 benefits year5_benefits: type: number title: Year5 Benefits description: Year 5 benefits year6_benefits: type: number title: Year6 Benefits description: Year 6 benefits year7_benefits: type: number title: Year7 Benefits description: Year 7 benefits year8_benefits: type: number title: Year8 Benefits description: Year 8 benefits year9_benefits: type: number title: Year9 Benefits description: Year 9 benefits year10_benefits: type: number title: Year10 Benefits description: Year 10 benefits total_benefits: type: number title: Total Benefits description: Total benefits account_solution_id: anyOf: - type: integer - type: 'null' title: Account Solution Id description: Account solution ID solution_name: anyOf: - type: string - type: 'null' title: Solution Name description: Solution name vp_specific: type: integer title: Vp Specific description: Was this metric created for one VP? default: 0 type: object required: - id - name - description - active - year1_benefits - year2_benefits - year3_benefits - year4_benefits - year5_benefits - year6_benefits - year7_benefits - year8_benefits - year9_benefits - year10_benefits - total_benefits title: Benefit description: Benefit model value_proposition__dynamic_discovery__models__Solution: properties: account_solution_id: type: integer title: Account Solution Id name: type: string title: Name description: anyOf: - type: string - type: 'null' title: Description default: '' type: object required: - account_solution_id - name title: Solution description: Solutions model value_proposition__factors__models__SourceType: properties: id: type: integer title: Id description: ID for the Source Type name: type: string title: Name description: Name of the Source Type description: anyOf: - type: string - type: 'null' title: Description description: Description of the Source Type type: object required: - id - name title: SourceType description: SourceType model value_proposition__facts__source_types__source_type__SourceType: properties: id: type: integer title: Id description: Unique identifier for the source type. name: type: string title: Name description: Name of the source type. description: anyOf: - type: string - type: 'null' title: Description description: Description of the source type. type: object required: - id - name title: SourceType description: Source Type Model value_proposition__solutions__models__Solution: properties: id: type: integer title: Id description: Solution ID value_prop_id: type: integer title: Value Prop Id description: Value Proposition ID account_solution_id: type: integer title: Account Solution Id description: Account Solution ID quantity: type: integer title: Quantity description: Quantity deployment_time: type: number title: Deployment Time description: Deployment Time name: type: string title: Name description: Name of the solution description: type: string title: Description description: Description of the solution quantity_enabled: type: integer title: Quantity Enabled description: Indicates if quantity is enabled type: object required: - id - value_prop_id - account_solution_id - quantity - deployment_time - name - description - quantity_enabled title: Solution description: Solution Model value_proposition__value_props__models__Benefit: properties: value_prop_metric_id: type: string title: Value Prop Metric Id description: Value proposition metric id driver_value: anyOf: - type: number - type: 'null' title: Driver Value description: Driver value impact_conservative: anyOf: - type: number - type: 'null' title: Impact Conservative description: Conservative impact act_impact_conservative: anyOf: - type: number - type: 'null' title: Act Impact Conservative description: Actual conservative impact impact_probable: anyOf: - type: number - type: 'null' title: Impact Probable description: Probable impact act_impact_probable: anyOf: - type: number - type: 'null' title: Act Impact Probable description: Actual probable impact impact_aggressive: anyOf: - type: number - type: 'null' title: Impact Aggressive description: Aggressive impact act_impact_aggressive: anyOf: - type: number - type: 'null' title: Act Impact Aggressive description: Actual aggressive impact impact: anyOf: - type: number - type: 'null' title: Impact description: Overall impact financial_value: anyOf: - type: number - type: 'null' title: Financial Value description: Financial value value_category_id: anyOf: - type: string - type: 'null' title: Value Category Id description: Value category ID current_effort: anyOf: - type: number - type: 'null' title: Current Effort description: Current effort term: anyOf: - type: integer - type: 'null' title: Term description: Term driver_factor: anyOf: - type: string - type: 'null' title: Driver Factor description: Driver factor driver_description: anyOf: - type: string - type: 'null' title: Driver Description description: Driver description d_precision: anyOf: - type: number - type: 'null' title: D Precision description: Driver precision f_precision: anyOf: - type: number - type: 'null' title: F Precision description: Financial precision i_precision: anyOf: - type: number - type: 'null' title: I Precision description: Impact precision account_solution_metric_id: anyOf: - type: string - type: 'null' title: Account Solution Metric Id description: Account solution metric ID account_solution_id: anyOf: - type: string - type: 'null' title: Account Solution Id description: Account solution ID solution_name: anyOf: - type: string - type: 'null' title: Solution Name description: Solution name sequence: anyOf: - type: integer - type: 'null' title: Sequence description: Sequence number metric_name: anyOf: - type: string - type: 'null' title: Metric Name description: Metric name original_metric_name: anyOf: - type: string - type: 'null' title: Original Metric Name description: Original metric name alt_metric_name: anyOf: - type: string - type: 'null' title: Alt Metric Name description: Alternate metric name quantity: anyOf: - type: integer - type: 'null' title: Quantity description: Quantity deployment_time: anyOf: - type: integer - type: 'null' title: Deployment Time description: Deployment time expense_type_id: anyOf: - type: integer - type: 'null' title: Expense Type Id description: Expense type ID description: anyOf: - type: string - type: 'null' title: Description description: Description of the benefit scale_type_id: anyOf: - type: integer - type: 'null' title: Scale Type Id description: Scale type ID unique_type_id: anyOf: - type: integer - type: 'null' title: Unique Type Id description: Unique type ID driver_factor_id: anyOf: - type: integer - type: 'null' title: Driver Factor Id description: Driver factor ID financial_factor_id: anyOf: - type: integer - type: 'null' title: Financial Factor Id description: Financial factor ID quantified: anyOf: - type: integer - type: 'null' title: Quantified description: Quantified flag soft: anyOf: - type: integer - type: 'null' title: Soft description: Soft flag unique_type: anyOf: - type: string - type: 'null' title: Unique Type description: Unique type unique_description: anyOf: - type: string - type: 'null' title: Unique Description description: Unique description impact_type: anyOf: - type: string - type: 'null' title: Impact Type description: Impact type impact_description: anyOf: - type: string - type: 'null' title: Impact Description description: Impact description driver_factor_vr_name: anyOf: - type: string - type: 'null' title: Driver Factor Vr Name description: Driver factor VR name financial_factor_vr_name: anyOf: - type: string - type: 'null' title: Financial Factor Vr Name description: Financial factor VR name improvement_factor_vr_name: anyOf: - type: string - type: 'null' title: Improvement Factor Vr Name description: Improvement factor VR name financial_factor: anyOf: - type: string - type: 'null' title: Financial Factor description: Financial factor financial_description: anyOf: - type: string - type: 'null' title: Financial Description description: Financial description d_unit_type_id: anyOf: - type: integer - type: 'null' title: D Unit Type Id description: Driver unit type ID f_unit_type_id: anyOf: - type: integer - type: 'null' title: F Unit Type Id description: Financial unit type ID i_unit_type_id: anyOf: - type: integer - type: 'null' title: I Unit Type Id description: Impact unit type ID accrual_type: anyOf: - type: string - type: 'null' title: Accrual Type description: Accrual type accrual_type_description: anyOf: - type: string - type: 'null' title: Accrual Type Description description: Accrual type description impact_override: anyOf: - type: number - type: 'null' title: Impact Override description: Impact override impact_source_type_id: anyOf: - type: integer - type: 'null' title: Impact Source Type Id description: Impact source type ID subtypes_enabled: anyOf: - type: integer - type: 'null' title: Subtypes Enabled description: Subtypes enabled flag vp_specific: anyOf: - type: integer - type: 'null' title: Vp Specific description: Value proposition specific flag features: anyOf: - type: string - type: 'null' title: Features description: Features description financial_estimate: anyOf: - type: number - type: 'null' title: Financial Estimate description: Financial estimate financial_override: anyOf: - type: number - type: 'null' title: Financial Override description: Financial override financial_baseline_answer: anyOf: - type: number - type: 'null' title: Financial Baseline Answer description: Financial baseline answer financial_source_type_id: anyOf: - type: integer - type: 'null' title: Financial Source Type Id description: Financial source type ID percent_driven: anyOf: - type: integer - type: 'null' title: Percent Driven description: Percent driven value_category: anyOf: - type: string - type: 'null' title: Value Category description: Value category vc_description: anyOf: - type: string - type: 'null' title: Vc Description description: VC description is_financial: anyOf: - type: integer - type: 'null' title: Is Financial description: Is financial flag fastfill_enabled: anyOf: - type: integer - type: 'null' title: Fastfill Enabled description: Fastfill enabled flag vc_sequence: anyOf: - type: integer - type: 'null' title: Vc Sequence description: VC sequence straight_scaling: anyOf: - type: integer - type: 'null' title: Straight Scaling description: Straight scaling flag benefit_type_id: anyOf: - type: integer - type: 'null' title: Benefit Type Id description: Benefit type ID benefit_type: anyOf: - type: string - type: 'null' title: Benefit Type description: Benefit type benefit_type_description: anyOf: - type: string - type: 'null' title: Benefit Type Description description: Benefit type description accrual_type_id: anyOf: - type: integer - type: 'null' title: Accrual Type Id description: Accrual type ID active: anyOf: - type: integer - type: 'null' title: Active description: Active flag impact_type_id: anyOf: - type: integer - type: 'null' title: Impact Type Id description: Impact type ID improvement_factor_id: anyOf: - type: integer - type: 'null' title: Improvement Factor Id description: Improvement factor ID improvement_factor: anyOf: - type: string - type: 'null' title: Improvement Factor description: Improvement factor improvement_description: anyOf: - type: string - type: 'null' title: Improvement Description description: Improvement description future_effort: anyOf: - type: number - type: 'null' title: Future Effort description: Future effort total_benefits_fmt: anyOf: - type: string - type: 'null' title: Total Benefits Fmt description: Formatted total benefits total_benefits_fr: anyOf: - type: string - type: 'null' title: Total Benefits Fr description: Total benefits impact_fmt: anyOf: - type: string - type: 'null' title: Impact Fmt description: Formatted impact total_benefits_p2: anyOf: - type: string - type: 'null' title: Total Benefits P2 description: Total benefits P2 type: object required: - value_prop_metric_id title: Benefit description: Benefit model securitySchemes: HTTPBearer: type: http description: Access token in the form of a JWT scheme: bearer servers: - url: https://api.xfactor.io description: Production API host (Auth0 audience of the Xfactor.io web application)