Skip to main content
GET
The contract register and detail header (UI spec §21).

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
contract_number
string
name
string
contract_type
string
contract_type_name
string
contract_category
string
status
string
status_label
string
status_category
string
vendor_id
string
vendor_number
string
vendor_name
string
site_id
string
site_code
string
site_name
string
start_date
string
end_date
string
signed_on
string
auto_renew
string
renewal_notice_days
string
contract_value
string
contract_value_currency_id
string
covers_parts
string
covers_labour
string
covers_travel
string
requires_authorized_vendor
string
scope
string
exclusions_summary
string
owner_name
string
external_reference
string
notes
string
is_live
string
has_expired
string
days_remaining
string
in_renewal_window
string
named_assets
string
covered_asset_types
string
visits_included
string
visits_used
string
claims
string
row_version
string
updated_at
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

auto_renew
boolean<boolean>
claims
integer<bigint>
contract_category
string<character varying>
Maximum string length: 30
contract_number
string<character varying>
Maximum string length: 60
contract_type
string<character varying>
Maximum string length: 40
contract_type_name
string<character varying>
Maximum string length: 150
contract_value
number<numeric>
contract_value_currency_id
string<uuid>
covered_asset_types
integer<bigint>
covers_labour
boolean<boolean>
covers_parts
boolean<boolean>
covers_travel
boolean<boolean>
days_remaining
integer<integer>
end_date
string<date>
exclusions_summary
string<text>
external_reference
string<character varying>
Maximum string length: 120
has_expired
boolean<boolean>
id
string<uuid>

Note: This is a Primary Key.

in_renewal_window
boolean<boolean>
is_live
boolean<boolean>
name
string<character varying>
Maximum string length: 200
named_assets
integer<bigint>
notes
string<text>
owner_name
string<character varying>
Maximum string length: 200
renewal_notice_days
integer<integer>
requires_authorized_vendor
boolean<boolean>
row_version
integer<bigint>
scope
string<text>
signed_on
string<date>
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

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

site_name
string<character varying>
Maximum string length: 200
start_date
string<date>
status
string<character varying>
Maximum string length: 60
status_category
string<character varying>
Maximum string length: 20
status_label
string<character varying>
Maximum string length: 150
updated_at
string<timestamp with time zone>
vendor_id
string<uuid>

Note: This is a Foreign Key to vendor_directory.vendor_id.

vendor_name
string<character varying>
Maximum string length: 200
vendor_number
string<character varying>
Maximum string length: 60
visits_included
integer<bigint>
visits_used
integer<bigint>