> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nueborder.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Forecast Settings

> Adjusts the forecast settings for carbon-tax calculations using the provided configuration.



## OpenAPI

````yaml api-reference/openapi.json put /v1/companies/{company_id}/forecast
openapi: 3.0.0
info:
  description: Validate, store, and query compliance carbon data.
  title: NueBorder API
  termsOfService: https://nueborder.com/terms/
  contact:
    name: Jack Dunlap
    url: https://nueborder.com/support
    email: support@nueborder.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
servers:
  - url: https://nueborder.com/api/v1
security: []
externalDocs:
  description: OpenAPI
  url: https://nueborder.com/openapi/
paths:
  /v1/companies/{company_id}/forecast:
    put:
      tags:
        - Forecast
      summary: Update Forecast Settings
      description: >-
        Adjusts the forecast settings for carbon-tax calculations using the
        provided configuration.
      parameters:
        - description: Unique identifier of the company
          name: company_id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/models.ForecastSetting'
        description: Forecast settings configuration
        required: true
      responses:
        '200':
          description: Forecast settings updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.SuccessResponse'
        '400':
          description: Invalid forecast settings provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.JSONPayloadErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/models.InternalServerErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    models.ForecastSetting:
      description: Forecast Setting defines configuration parameters.
      type: object
      properties:
        carbonPrice:
          description: Carbon price.
          type: number
          example: 15
        discount:
          description: Discount rate.
          type: number
          example: 0.1
        importRegion:
          description: Region for the settings.
          type: string
          enum:
            - EU
          example: EU
        reportingPeriod:
          description: Reporting period.
          type: string
          example: Q1
        year:
          description: Year for the settings.
          type: integer
          example: 2023
        yoyChange:
          description: Year-over-year change.
          type: number
          example: 0.05
    models.SuccessResponse:
      description: A standard successful API response.
      type: object
      properties:
        message:
          description: A detailed success message.
          type: string
          example: Operation completed successfully
        status:
          description: HTTP status code.
          type: integer
          example: 200
    models.JSONPayloadErrorResponse:
      description: A response indicating that the JSON payload is invalid.
      type: object
      properties:
        message:
          description: A detailed error message.
          type: string
          example: The JSON payload is invalid
        status:
          description: HTTP status code.
          type: integer
          example: 400
    models.InternalServerErrorResponse:
      description: A response indicating that an internal server error occurred.
      type: object
      properties:
        message:
          description: A detailed error message.
          type: string
          example: An internal server error occurred
        status:
          description: HTTP status code.
          type: integer
          example: 500
  securitySchemes:
    BearerAuth:
      description: 'Provide your Bearer token in the format: Bearer <your_api_key>'
      type: apiKey
      name: Authorization
      in: header

````