Skip to main content
PUT
/
v1
/
companies
/
{company_id}
/
forecast
Update Forecast Settings
curl --request PUT \
  --url https://nueborder.com/api/v1/v1/companies/{company_id}/forecast \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "carbonPrice": 15,
  "discount": 0.1,
  "importRegion": "EU",
  "reportingPeriod": "Q1",
  "year": 2023,
  "yoyChange": 0.05
}'
{
  "message": "Operation completed successfully",
  "status": 200
}

Authorizations

​
Authorization
string
header
required

Provide your Bearer token in the format: Bearer <your_api_key>

Path Parameters

​
company_id
string
required

Unique identifier of the company

Body

application/json

Forecast settings configuration

Forecast Setting defines configuration parameters.

​
carbonPrice
number

Carbon price.

Example:

15

​
discount
number

Discount rate.

Example:

0.1

​
importRegion
enum<string>

Region for the settings.

Available options:
EU
Example:

"EU"

​
reportingPeriod
string

Reporting period.

Example:

"Q1"

​
year
integer

Year for the settings.

Example:

2023

​
yoyChange
number

Year-over-year change.

Example:

0.05

Response

Forecast settings updated successfully

A standard successful API response.

​
message
string

A detailed success message.

Example:

"Operation completed successfully"

​
status
integer

HTTP status code.

Example:

200