Skip to main content
GET
How much of a contract's value the claims against it have used, against what the agreement is

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

contract_id
string
contract_number
string
contract_name
string
vendor_id
string
vendor_name
string
start_date
string
end_date
string
currency_code
string
currency_symbol
string
currency_decimal_places
string
contract_value
string
consumed
string
committed
string
remaining
string
remaining_after_committed
string
percent_consumed
string
percent_committed
string
has_value
string
consumed_claims
string
committed_claims
string
uncounted_claims
string
unconverted_claims
string
is_over_value
string
is_over_value_with_committed
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

committed
number<numeric>
committed_claims
integer<bigint>
consumed
number<numeric>
consumed_claims
integer<bigint>
contract_id
string<uuid>

Note: This is a Primary Key.

contract_name
string<character varying>
Maximum string length: 200
contract_number
string<character varying>
Maximum string length: 60
contract_value
number<numeric>
currency_code
string<character varying>
Maximum string length: 3
currency_decimal_places
integer<smallint>
currency_symbol
string<character varying>
Maximum string length: 10
end_date
string<date>
has_value
boolean<boolean>
is_over_value
boolean<boolean>
is_over_value_with_committed
boolean<boolean>
percent_committed
number<numeric>
percent_consumed
number<numeric>
remaining
number<numeric>
remaining_after_committed
number<numeric>
start_date
string<date>
unconverted_claims
integer<bigint>
uncounted_claims
integer<bigint>
vendor_id
string<uuid>

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

vendor_name
string<character varying>
Maximum string length: 200