Burn Rate

The burn rate resource.

Base/burnRate

GET/burnRate

List burn rates

Retrieve a paginated list of burn rates. 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/burnRate

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

Response

[
  {
    "id": "abc123def456",
    "companyId": "xyz789",
    "customerLocationId": "xyz789",
    "createdBy": "string",
    "createdAt": "2026-01-01T00:00:00Z",
    "kFactor": 0,
    "method": "string",
    "intervalDays": 0
  }
]

GET/burnRate

Retrieve a burn rate

Fetch a single burn rate by filtering on `id`.

Query parameters

idstring

Match on the burn rate's `id`, e.g. `eq.{id}`.

GET/burnRate

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerLocationId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "kFactor": 0,
  "method": "string",
  "intervalDays": 0
}

POST/burnRate

Create a burn rate

Create a new burn rate.

Body parameters

companyIdstringrequired

References company.id

customerLocationIdstringrequired

References customerLocation.id

kFactornumber

methodstring

intervalDaysnumber

intervalHddnumber

gallonsDeliverednumber

confidencenumber

validFromdate

validTodate

POST/burnRate

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerLocationId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "kFactor": 0,
  "method": "string",
  "intervalDays": 0
}

PATCH/burnRate

Update a burn rate

Update an existing burn rate, matched on `id`.

Body parameters

companyIdstringrequired

References company.id

customerLocationIdstringrequired

References customerLocation.id

kFactornumber

methodstring

intervalDaysnumber

intervalHddnumber

gallonsDeliverednumber

confidencenumber

validFromdate

validTodate

PATCH/burnRate

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

Response

{
  "id": "abc123def456",
  "companyId": "xyz789",
  "customerLocationId": "xyz789",
  "createdBy": "string",
  "createdAt": "2026-01-01T00:00:00Z",
  "kFactor": 0,
  "method": "string",
  "intervalDays": 0
}

DELETE/burnRate

Delete a burn rate

Delete a burn rate, matched on `id`. Returns 204 No Content.

Query parameters

idstring

The `id` of the burn rate to delete, e.g. `eq.{id}`.

DELETE/burnRate

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

204 No Content