Skip to main content
GET
Reductions somebody has committed to, with where each one stands: the allowance its baseline implies, what has been used against it, and whether that is ahead or behind pace.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
name
string
commodity_id
string
commodity_name
string
unit_code
string
site_id
string
site_name
string
supply_point_id
string
supply_point_code
string
reduction_ratio
string
baseline_period_start
string
baseline_period_end
string
period_start
string
period_end
string
is_active
string
supply_points
string
baseline_consumption
string
baseline_months
string
baseline_months_measured
string
allowance
string
consumed
string
consumed_ratio
string
expected_ratio
string
forecast
string
forecast_ratio
string
pacing
string
period_status
string
standing
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

allowance
number<numeric>
baseline_consumption
number<numeric>
baseline_months
integer<integer>
baseline_months_measured
integer<integer>
baseline_period_end
string<date>
baseline_period_start
string<date>
commodity_id
string<uuid>

Note: This is a Foreign Key to commodities.id.

commodity_name
string<character varying>
Maximum string length: 120
consumed
number<numeric>
consumed_ratio
number<numeric>
expected_ratio
number<numeric>
forecast
number<numeric>
forecast_ratio
number<numeric>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
name
string<character varying>
Maximum string length: 150
pacing
string<text>
period_end
string<date>
period_start
string<date>
period_status
string<text>
reduction_ratio
number<numeric>
site_id
string<uuid>

Note: This is a Foreign Key to entry_currencies.for_site_id.

site_name
string<character varying>
Maximum string length: 200
standing
string<text>
supply_point_code
string<character varying>
Maximum string length: 60
supply_point_id
string<uuid>

Note: This is a Foreign Key to supply_points.id.

supply_points
integer<integer>
unit_code
string<character varying>
Maximum string length: 30