Tank Forecast

The tank forecast resource.

Base/tankForecast

GET/tankForecast

List tank forecasts

Retrieve a paginated list of tank forecasts. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GET/tankForecast

curl --request GET \
  --url '<your-host>/tankForecast?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "tankId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "updatedAt": "2026-01-01T00:00:00Z",
    "forecastType": "string",
    "degreeDayRegion": "string"
  }
]

GET/tankForecast

Retrieve a tank forecast

Fetch a single tank forecast by filtering on `id`.

Query parameters

idstring

Match on the tank forecast's `id`, e.g. `eq.{id}`.

GET/tankForecast

curl --request GET \
  --url '<your-host>/tankForecast?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "forecastType": "string",
  "degreeDayRegion": "string"
}

POST/tankForecast

Create a tank forecast

Create a new tank forecast.

Body parameters

tankIdstringrequired

forecastTypestring

degreeDayRegionstring

currentDegreeDaynumber

nextDeliveryDegreeDaynumber

runOutDegreeDaynumber

estimatedPercentFullnumber

quantityInTankGallonsnumber

estimatedNextDeliveryDatedate

nextDeliveryDatedate

nextDeliveryDateOverridedate

estimatedNextDeliveryBasedOnstring

lastDeliveryDatedate

previousFullDeliveryDatedate

kFactorWinternumber

kFactorSpringnumber

kFactorSummernumber

kFactorFallnumber

baseLoadWinternumber

baseLoadSpringnumber

baseLoadSummernumber

baseLoadFallnumber

hasOpenDeliveryboolean

POST/tankForecast

curl --request POST \
  --url <your-host>/tankForecast \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"tankId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "forecastType": "string",
  "degreeDayRegion": "string"
}

PATCH/tankForecast

Update a tank forecast

Update an existing tank forecast, matched on `id`.

Body parameters

tankIdstringrequired

forecastTypestring

degreeDayRegionstring

currentDegreeDaynumber

nextDeliveryDegreeDaynumber

runOutDegreeDaynumber

estimatedPercentFullnumber

quantityInTankGallonsnumber

estimatedNextDeliveryDatedate

nextDeliveryDatedate

nextDeliveryDateOverridedate

estimatedNextDeliveryBasedOnstring

lastDeliveryDatedate

previousFullDeliveryDatedate

kFactorWinternumber

kFactorSpringnumber

kFactorSummernumber

kFactorFallnumber

baseLoadWinternumber

baseLoadSpringnumber

baseLoadSummernumber

baseLoadFallnumber

hasOpenDeliveryboolean

PATCH/tankForecast

curl --request PATCH \
  --url '<your-host>/tankForecast?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"tankId":"xyz789"}'

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "tankId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "updatedAt": "2026-01-01T00:00:00Z",
  "forecastType": "string",
  "degreeDayRegion": "string"
}

DELETE/tankForecast

Delete a tank forecast

Delete a tank forecast, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the tank forecast to delete, e.g. `eq.{id}`.

DELETE/tankForecast

curl --request DELETE \
  --url '<your-host>/tankForecast?id=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content