Validere

Validere estimation_methods API

Estimation Methods

Documentation GitHub OpenAPI

Operations 26

POST /app/v1/estimation_methods/ Bulk create estimation methods #

POST /app/v1/estimation_methods/run Run calculators based on filtered configurations #

POST /app/v2/estimation_methods/run Bulk run calculators based on filtered configurations #

POST /app/v2/estimation_methods/run_async Start an asynchronous job to bulk run calculators based on filtered configurations #

POST /app/v1/estimation_methods/search Search and list Estimation Methods #

POST /app/v1/estimation_methods/search/configurations Search and list Estimation Methods with calculator configs and runs #

POST /app/v1/estimation_methods/export Export estimation methods based on search input #

POST /app/v1/estimation_methods/export/configurations Search and export Estimation Methods with calculator configs and runs #

POST /app/v1/estimation_methods/{entity_type} Add Estimation Method to Entity #

GET /app/v1/estimation_methods/{entity_type}/{id} Get an estimation method #

PUT /app/v1/estimation_methods/{entity_type}/{id} Update an estimation method #

DELETE /app/v1/estimation_methods/{entity_type}/{id} Delete an estimation method #

GET /app/v1/estimation_methods/{entity_type}/{id}/runs List runs for a given estimation method #

GET /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month} Get an estimation method configuration #

PUT /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month} Update an estimation method configuration #

PUT /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}/apply_defaults Re-apply defaults to a calculator configuration #

PUT /app/v1/estimation_methods/configurations/apply_defaults Re-apply defaults to multiple calculator configurations #

POST /app/v1/estimation_methods/configurations/apply_defaults_async Start an asynchronous job to re-apply defaults to multiple calculator configurations #

GET /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}/run Get a calculator run #

POST /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}/run Run estimation method calculator for a single period #

PUT /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{input_name} Set the input record for a given calculator configuration #

GET /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{input_name} Get the input record for a given calculator configuration #

DELETE /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{input_name} Delete the input record for a given calculator configuration #

PUT /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{target_asset_id}/{input_name} Set the input record for a given calculator configuration and target asset #

GET /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{target_asset_id}/{input_name} Get the input record for a given calculator configuration and target asset #

DELETE /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{target_asset_id}/{input_name} Delete the input record for a given calculator configuration and target asset #

Documentation

📖

Documentation

https://docs.validere.com/guides/api/app

📖

Documentation

https://docs.validere.com/guides/api/data

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/validere/refs/heads/main/openapi/validere-estimation-methods-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/validere-estimation-methods-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: Activity Log
  title: CarbonHub activities Estimation Methods API
  version: 1.0.0
servers:
- url: https://api.validere.io
security:
- Staging: []
- Integration: []
- Local: []
tags:
- description: Estimation Methods
  name: estimation_methods
paths:
  /app/v1/estimation_methods/:
    post:
      operationId: bulk_add_estimation_method
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkAddEstimationMethodToEntitiesRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEstimationMethodsBulkResponse'
          description: Successfully Created Estimation Methods in bulk
      summary: Bulk create estimation methods
      tags:
      - estimation_methods
  /app/v1/estimation_methods/run:
    post:
      deprecated: true
      operationId: run_estimation_methods
      parameters:
      - $ref: '#/components/parameters/PreviewCalculation'
      - $ref: '#/components/parameters/PromoteCalculation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatorRunsFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorRunsResponse'
          description: Successfully ran estimation method calculations
      summary: Run calculators based on filtered configurations
      tags:
      - estimation_methods
  /app/v2/estimation_methods/run:
    post:
      operationId: run_estimation_methods_v2
      parameters:
      - $ref: '#/components/parameters/PreviewCalculation'
      - $ref: '#/components/parameters/PromoteCalculation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatorRunsFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorRunsBulkResponse'
          description: Successfully ran estimation method calculations
      summary: Bulk run calculators based on filtered configurations
      tags:
      - estimation_methods
  /app/v2/estimation_methods/run_async:
    post:
      operationId: run_async_estimation_methods_v2
      parameters:
      - $ref: '#/components/parameters/PreviewCalculation'
      - $ref: '#/components/parameters/PromoteCalculation'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatorRunsFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorAsyncRunsBulkResponse'
          description: Successfully starts an asynchronous job to run estimation method calculations
      summary: Start an asynchronous job to bulk run calculators based on filtered configurations
      tags:
      - estimation_methods
  /app/v1/estimation_methods/search:
    post:
      operationId: search_estimation_methods
      parameters:
      - $ref: '#/components/parameters/parameters-Period'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/Paginated'
              - $ref: '#/components/schemas/EstimationMethodSort'
              - $ref: '#/components/schemas/EstimationMethodFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEstimationMethodList'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: '#/components/schemas/XLSXResponse'
          description: Successfully something
      summary: Search and list Estimation Methods
      tags:
      - estimation_methods
  /app/v1/estimation_methods/search/configurations:
    post:
      operationId: search_estimation_method_configurations
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/Paginated'
              - $ref: '#/components/schemas/EstimationMethodConfigurationSort'
              - $ref: '#/components/schemas/EstimationMethodConfigurationFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedEstimationMethodWithConfigurationList'
            application/vnd.openxmlformats-officedocument.spreadsheetml.sheet:
              schema:
                $ref: '#/components/schemas/XLSXResponse'
          description: Successfully something
      summary: Search and list Estimation Methods with calculator configs and runs
      tags:
      - estimation_methods
  /app/v1/estimation_methods/export:
    post:
      operationId: export_estimation_methods
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/EstimationMethodSort'
              - $ref: '#/components/schemas/EstimationMethodFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportWithS3Url'
          description: A successful with the link to download report
      summary: Export estimation methods based on search input
      tags:
      - estimation_methods
  /app/v1/estimation_methods/export/configurations:
    post:
      operationId: export_estimation_method_configurations
      requestBody:
        content:
          application/json:
            schema:
              type: object
              allOf:
              - $ref: '#/components/schemas/EstimationMethodConfigurationSort'
              - $ref: '#/components/schemas/EstimationMethodConfigurationFilter'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportWithS3Url'
          description: A successful with the link to download report
      summary: Search and export Estimation Methods with calculator configs and runs
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}:
    post:
      operationId: add_estimation_method
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddEstimationMethodToEntityRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimationMethodWithEntityInfoResponse'
          description: Successfully Added Estimation Method to Entity
      summary: Add Estimation Method to Entity
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}:
    get:
      operationId: get_estimation_method
      parameters:
      - $ref: '#/components/parameters/parameters-EstimationMethodEntityType'
      - $ref: '#/components/parameters/parameters-EstimationMethodId'
      - $ref: '#/components/parameters/parameters-Period'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimationMethodWithReportingGroupsResponse'
          description: Successfully retrieved an estimation event
      summary: Get an estimation method
      tags:
      - estimation_methods
    put:
      operationId: update_estimation_method
      parameters:
      - $ref: '#/components/parameters/parameters-EstimationMethodEntityType'
      - $ref: '#/components/parameters/parameters-EstimationMethodId'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEstimationMethodRequestBody'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateEstimationMethodResponse'
          description: Successfully updated an estimation event
      summary: Update an estimation method
      tags:
      - estimation_methods
    delete:
      operationId: delete_estimation_method
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      responses:
        '200':
          description: A successful operation
      summary: Delete an estimation method
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/runs:
    get:
      operationId: list_estimation_method_runs
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/PageSize'
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/SortBy'
      - $ref: '#/components/parameters/SortDirection'
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Pagination'
                - $ref: '#/components/schemas/CalculatorRunsResponse'
          description: Successfully return runs for a given estimation method
      summary: List runs for a given estimation method
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}:
    get:
      operationId: get_estimation_method_configuration
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimationMethodConfiguration'
          description: Successfully retrieved an estimation method configuration
      summary: Get an estimation method configuration
      tags:
      - estimation_methods
    put:
      operationId: update_estimation_method_configuration
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetCalculatorConfigurationRequestBody'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EstimationMethodConfiguration'
          description: Successfully updated an estimation method configuration
      summary: Update an estimation method configuration
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}/apply_defaults:
    put:
      operationId: apply_defaults_estimation_method_configuration
      parameters:
      - $ref: '#/components/parameters/parameters-EstimationMethodEntityType'
      - $ref: '#/components/parameters/parameters-EstimationMethodId'
      - $ref: '#/components/parameters/parameters-YearMonth'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplyDefaultsEstimationMethodConfigurationResponse'
          description: Successfully set defaults on the calculator configuration
      summary: Re-apply defaults to a calculator configuration
      tags:
      - estimation_methods
  /app/v1/estimation_methods/configurations/apply_defaults:
    put:
      operationId: bulk_apply_defaults_estimation_method_configuration
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  estimation_method_id:
                    type: string
                    format: uuid
                  year_month:
                    type: string
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BulkResponse'
                - properties:
                    data:
                      description: Dictionary of results where the key is {Estimation method ID}_{Year month}
                      type: object
                      additionalProperties:
                        properties:
                          status:
                            $ref: '#/components/schemas/BulkItemStatus'
                          error:
                            type: string
                          errors:
                            type: array
                            description: List of errors
                            items:
                              $ref: '#/components/schemas/CalculationResultError'
                          data:
                            type: object
                            properties:
                              estimation_method_id:
                                type: string
                                format: UUID
                              year_month:
                                type: string
                              calculation_status:
                                $ref: '#/components/schemas/CalculationStatus'
          description: Successfully set defaults on the calculator configurations
      summary: Re-apply defaults to multiple calculator configurations
      tags:
      - estimation_methods
  /app/v1/estimation_methods/configurations/apply_defaults_async:
    post:
      operationId: bulk_apply_defaults_estimation_method_configuration_async
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/EstimationMethodConfigurationFilter'
              - properties:
                  year_months:
                    type: array
                    items:
                      type: string
                      example: 202212
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/BulkResponse'
                - properties:
                    job:
                      $ref: '#/components/schemas/Job'
          description: Successfully starts an asynchronous job to set defaults on the calculator configurations
      summary: Start an asynchronous job to re-apply defaults to multiple calculator configurations
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/configuration/{year_month}/run:
    get:
      operationId: get_estimation_method_configuration_run
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorRunSourceResponse'
          description: Successfully retrieved a calculator run
      summary: Get a calculator run
      tags:
      - estimation_methods
    post:
      operationId: run_estimation_method_configuration
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/PreviewCalculation'
      - $ref: '#/components/parameters/PromoteCalculation'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorRunSourceResponse'
          description: Successfully ran estimation method calculations
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorRun422Error'
          description: Calculator validation error
      summary: Run estimation method calculator for a single period
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{input_name}:
    put:
      operationId: set_calculator_input_record
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatorInputRecordInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorInputRecord'
          description: Successfully updated calculator input record
      summary: Set the input record for a given calculator configuration
      tags:
      - estimation_methods
    get:
      operationId: get_calculator_input_record
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorInputRecord'
          description: A successful operation
      summary: Get the input record for a given calculator configuration
      tags:
      - estimation_methods
    delete:
      operationId: delete_calculator_input_record
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      responses:
        '200':
          description: A successful operation
      summary: Delete the input record for a given calculator configuration
      tags:
      - estimation_methods
  /app/v1/estimation_methods/{entity_type}/{id}/record/{year_month}/{target_asset_id}/{input_name}:
    put:
      operationId: set_calculator_input_record_target_asset
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodTargetAssetId'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CalculatorInputRecordInput'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorInputRecord'
          description: Successfully updated calculator input record on target asset
      summary: Set the input record for a given calculator configuration and target asset
      tags:
      - estimation_methods
    get:
      operationId: get_calculator_input_record_target_asset
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodTargetAssetId'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CalculatorInputRecord'
          description: A successful operation
      summary: Get the input record for a given calculator configuration and target asset
      tags:
      - estimation_methods
    delete:
      operationId: delete_calculator_input_record_target_asset
      parameters:
      - $ref: '#/components/parameters/EstimationMethodEntityType'
      - $ref: '#/components/parameters/EstimationMethodId'
      - $ref: '#/components/parameters/YearMonth'
      - $ref: '#/components/parameters/EstimationMethodTargetAssetId'
      - $ref: '#/components/parameters/EstimationMethodInputName'
      responses:
        '200':
          description: A successful operation
      summary: Delete the input record for a given calculator configuration and target asset
      tags:
      - estimation_methods
components:
  schemas:
    CalculatorInput:
      type: object
      properties:
        id:
          type: string
          example: bfbd6b12-4229-4c43-b08f-94f2a72fa0f8_202305
        calculation:
          $ref: '#/components/schemas/CalculatorInputCalculation'
    UpdateEstimationMethodResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
        company_id:
          type: string
          format: uuid
        asset_id:
          type: string
          format: uuid
        analytics_library_id:
          type: string
          minLength: 1
          maxLength: 255
          example: 2024-SubpartW
        analytics_calculator_id:
          type: string
          minLength: 1
          maxLength: 255
          example: 2024-SubpartW-AcidGasRemovalMethod1
        name:
          type: string
          minLength: 1
          maxLength: 255
          example: SubpartW AGR Method
        status:
          type: string
          enum:
          - active
          - inactive
        default_values:
          type: object
          additionalProperties:
            type: object
            properties:
              value:
                anyOf:
                - type: string
                - type: number
                - {}
                - type: boolean
                - {}
              unit:
                type: string
              measurement_type:
                type: string
              measurement_quantity:
                type: string
            required:
            - value
          example:
            fuel_type:
              value: Eastern
              unit: ''
              measurement_type: measurement_type
              measurement_quantity: dimensionless_coefficient
            volume:
              value: 5
              unit: e3m3
              measurement_type: measurement_type
              measurement_quantity: volume
        default_asset_values:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              properties:
                value:
                  anyOf:
                  - type: string
                  - type: number
                  - {}
                  - type: boolean
                  - {}
                unit:
                  type: string
                measurement_type:
                  type: string
                measurement_quantity:
                  type: string
              required:
              - value
            example:
              fuel_type:
                value: Eastern
                unit: ''
                measurement_type: measurement_type
                measurement_quantity: dimensionless_coefficient
              volume:
                value: 5
                unit: e3m3
                measurement_type: measurement_type
                measurement_quantity: volume
          example:
            a04b4387-5145-4935-9edc-d53ecdb7a6c0:
              fuel_type:
                value: Eastern
                unit: ''
                measurement_type: measurement_type
                measurement_quantity: dimensionless_coefficient
              volume:
                value: 5
                unit: e3m3
                measurement_type: measurement_type
                measurement_quantity: volume
            99a45dd3-6ce1-4290-9d16-79415111cc43:
              fuel_type:
                value: Eastern
                unit: ''
                measurement_type: measurement_type
                measurement_quantity: dimensionless_coefficient
              volume:
                value: 5
                unit: e3m3
                measurement_type: measurement_type
                measurement_quantity: volume
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type:
            - string
            - 'null'
          - {}
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type:
            - string
            - 'null'
          - {}
        created_by:
          type: string
          format: uuid
        updated_by:
          type: string
          format: uuid
        entity_type:
          type: string
          enum:
          - equipment
          - flow
          - asset_group
        entity_id:
          type: string
          format: uuid
        start_date:
          type: string
          description: Year month formatted as YYYYMM
          example: '202101'
        end_date:
          type: string
          description: Year month formatted as YYYYMM
          example: '202101'
      required:
      - id
      - company_id
      - asset_id
      - analytics_library_id
      - analytics_calculator_id
      - name
      - status
      - default_values
      - default_asset_values
      - created_at
      - updated_at
      - created_by
      - updated_by
      - entity_type
      - entity_id
      - start_date
      - end_date
      additionalProperties: false
    EstimationMethodFilter:
      properties:
        filter:
          description: A filter object for Estimation Methods where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
          example:
            $or:
            - entity_type: equipment
            - name:
                $like: Emissions
          allOf:
          - $ref: '#/components/schemas/EquipmentPrimaryFilterFieldsWithPrefix'
          - $ref: '#/components/schemas/FlowPrimaryFilterFieldsWithPrefix'
          - $ref: '#/components/schemas/EquipmentFacilityPrimaryFilterFieldsWithPrefix'
          - $ref: '#/components/schemas/FlowFacilityPrimaryFilterFieldsWithPrefix'
          - $ref: '#/components/schemas/FlowEquipmentPrimaryFilterFieldsWithPrefix'
          - properties:
              id:
                type: string
              name:
                type: string
              entity_id:
                type: string
              entity_type:
                type: string
                enum:
                - equipment
                - flow
                - asset_group
              analytics_library_id:
                type: string
              analytics_calculator_id:
                type: string
              status:
                type: string
              created_at:
                type: string
              created_by:
                type: string
              updated_at:
                type: string
              updated_by:
                type: string
              reporting_group_id:
                type: string
            type: object
          type: object
    XLSXResponse:
      format: binary
      type: string
    CalculatorResultRecordValueConfiguration:
      properties:
        configuration_type:
          type: string
          enum:
          - calculator_result
        aggregate_function:
          $ref: '#/components/schemas/RecordValueConfigurationFunction'
        calculator_result_ids:
          type: array
          items:
            format: uuid
            type: string
      type: object
    EquipmentStatus:
      type: string
      enum:
      - active
      - inactive
      - deprecated
    YearMonth:
      type: string
    CalculatorAsyncRunsBulkResponse:
      allOf:
      - $ref: '#/components/schemas/BulkResponse'
      - properties:
          job:
            $ref: '#/components/schemas/Job'
    EstimationMethodId:
      type: string
      format: uuid
    CalculationResultError:
      description: Calculation specific error
      type: object
      properties:
        loc:
          description: Parameter where the error occurred
          type: string
          example: mass_injected
        msg:
          description: Error message
          type: string
          example: Field required
        type:
          description: Type of error
          type: string
          example: missing
    AnalyticsCalculatorInputs:
      type: object
      example:
        fuel_type:
          value: Eastern
          unit: ''
          measurement_type: measurement_type
          measurement_quantity: dimensionless_coefficient
        volume:
          value: 5
          unit: e3m3
          measurement_type: measurement_type
          measurement_quantity: volume
        rvp: null
    CalculatorOutput:
      type: object
      properties:
        intermediates:
          type: array
          items:
            $ref: '#/components/schemas/CalculatorOutputMeasurement'
        outputs:
          type: array
          items:
            $ref: '#/components/schemas/CalculatorOutputMeasurement'
    EstimationMethodConfigurationSort:
      properties:
        sort_by:
          enum:
          - name
          - year_month
          - entity_id
          - entity_type
          - analytics_library_id
          - analytics_calculator_id
          - created_at
          - updated_at
          example: name
          type: string
        sort_direction:
          default: desc
          description: Sort direction
          enum:
          - asc
          - desc
          example: desc
          type: string
    AnalyticsCalculatorAssetInputs:
      type: object
      additionalProperties:
        $ref: '#/components/schemas/AnalyticsCalculatorInputs'
    FlowStatus:
      type: string
      enum:
      - active
      - inactive
    PagedEstimationMethodWithConfigurationList:
      allOf:
      - $ref: '#/components/schemas/Pagination'
      - properties:
          data:
            items:
              allOf:
              - $ref: '#/components/schemas/EstimationMethodWithRenamedStatusResponse'
              - properties:
                  facility_id:
                    type: string
                    format: uuid
                  facility_name:
                    type: string
                  entity_name:
                    type: string
                  entity_type_type:
                    type: string
                    description: eg. equipment type or facility type
                  status:
                    $ref: '#/components/schemas/CalculationStatus'
                  calculator_configuration:
                    $ref: '#/components/schemas/EstimationMethodConfiguration'
                  calculator_run:
                    $ref: '#/components/schemas/CalculatorRunResponse'
                  reporting_groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReportingGroupInput'
            type: array
        type: object
    Pagination:
      properties:
        page_number:
          type: number
          example: 0
        page_size:
          type: number
          example: 10
        total_entries:
          type: number
          example: 58
        total_pages:
          type: number
          example: 6
      type: object
    ProductCategories:
      type: string
      description: Use `id` value of any index in `GET /v1/product_categories`
    CalculatorRunInputSources:
      type: object
      allOf:
      - $r

# --- truncated at 32 KB (106 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/validere/refs/heads/main/openapi/validere-estimation-methods-api-openapi.yml