Skip to main content
GET
The named rule sets a book resolves: method, life or rate, residual, and how a part period is charged.

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
code
string
name
string
method
string
useful_life_months
string
annual_rate_percent
string
declining_factor
string
switch_to_straight_line
string
rate_table_id
string
rate_table_code
string
rate_table_convention
string
residual_percent
string
residual_amount
string
immediate_expense_below
string
first_period_convention
string
period_basis
string
is_active
string
asset_meter_type_id
string
meter_type_code
string
meter_type_name
string
total_expected_units
string
shift_uplift
string
effective_annual_rate
string
used_by_rules
string
enrolments
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

annual_rate_percent
number<numeric>
asset_meter_type_id
string<uuid>

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

code
string<character varying>
Maximum string length: 40
declining_factor
number<numeric>
effective_annual_rate
number<numeric>
enrolments
integer<bigint>
first_period_convention
string<character varying>
Maximum string length: 20
id
string<uuid>

Note: This is a Primary Key.

immediate_expense_below
number<numeric>
is_active
boolean<boolean>
meter_type_code
string<character varying>
Maximum string length: 60
meter_type_name
string<character varying>
Maximum string length: 150
method
string<character varying>
Maximum string length: 24
name
string<character varying>
Maximum string length: 150
period_basis
string<character varying>
Maximum string length: 16
rate_table_code
string<character varying>
Maximum string length: 60
rate_table_convention
string<character varying>
Maximum string length: 20
rate_table_id
string<uuid>

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

residual_amount
number<numeric>
residual_percent
number<numeric>
shift_uplift
boolean<boolean>
switch_to_straight_line
boolean<boolean>
total_expected_units
number<numeric>
used_by_rules
integer<bigint>
useful_life_months
integer<integer>