> ## Documentation Index
> Fetch the complete documentation index at: https://docs.assetinfinity.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# How much of a contract's value the claims against it have used, against what the agreement is
> worth.
`consumed` is what the vendor has agreed to absorb, `committed` what has been asked for and not yet
answered; they are separate because adding them would answer neither question. Every amount is in
`currency_code`, resolved once for the tenant, and `unconverted_claims` counts claims left out of
the totals because no rate covered their currency on the day. `percent_consumed` is null where the
contract carries no value to divide by — `has_value` says which case it is.
## OpenAPI
````yaml /api-reference/openapi.json get /contract_value_usage
openapi: 3.0.0
info:
description: ''
title: >-
The only schema PostgREST exposes. Reads are security_invoker views; writes
are SECURITY DEFINER functions. Rebuilt wholesale on every deploy — it holds
no data.
version: 12.2.3
servers:
- url: https://app.assetinfinity.ai/api
security: []
tags:
- name: Signing in
- name: Profile
- name: Assets
- name: Asset lifecycle
- name: Work lifecycle
- name: Maintenance
- name: Inventory
- name: Inventory detail
- name: Procurement
- name: Contracts
- name: Workforce
- name: Capacity
- name: Dispatch
- name: Tools
- name: Inspections
- name: Verification
- name: Reliability
- name: Parts demand
- name: Sensors and meters
- name: Map
- name: Floor plans
- name: Labels
- name: Lost and found
- name: Root cause analysis
- name: Reports
- name: Audit center
- name: Activity
- name: Notifications
- name: Channels
- name: Search
- name: Copilot
- name: Import
- name: Files
- name: Sync
- name: Support
- name: Admin
- name: Access
- name: Lookups
- name: Read models
- name: Branding
- name: Custom fields
- name: Form studio
- name: Workflows
- name: Workflow studio
- name: Rules
- name: Statuses and transitions
- name: Currencies and locales
- name: Work configuration
- name: Asset configuration
- name: Inventory configuration
- name: Tool configuration
- name: Workforce configuration
- name: Vendor and contract configuration
- name: Document configuration
- name: Inspection configuration
- name: Sites, locations and the organisation
- name: Platform
- name: Amendments
- name: Asset clone
- name: Asset components
- name: Asset register
- name: Asset transfer
- name: Audit feed
- name: Billing
- name: Bookings
- name: Budgets
- name: Bulk jobs
- name: Calibration history
- name: Capex plans
- name: Conversations
- name: Costing
- name: Currency
- name: Dashboards
- name: Directory sync
- name: Document control
- name: Document folders
- name: Document tree
- name: Documents
- name: Energy
- name: Extracts
- name: Features
- name: Feeds
- name: File exchange
- name: Filing exceptions
- name: Finance
- name: Inbound mail
- name: Keys
- name: Knowledge
- name: Licence
- name: List views
- name: Locations
- name: Mapping
- name: Mcp
- name: Mcp oauth
- name: Mfa
- name: Numbering
- name: Permits
- name: Readers
- name: Reference
- name: Reference columns
- name: Reference entry
- name: Release
- name: Scim
- name: Security streams
- name: Self verification
- name: Setup
- name: Shutdown
- name: Sso
- name: Telegram
- name: Tenant switch
- name: The caller's own work
- name: The checklist library
- name: Tools on a job, and who has them out
- name: Tray
- name: Vendor spend forecast
- name: Vendors and contracts
- name: Visitors
- name: Work order execution
- name: Work sequencing
- name: Workforce detail
externalDocs:
description: PostgREST Documentation
url: https://postgrest.org/en/v12/references/api.html
paths:
/contract_value_usage:
get:
tags:
- Contracts
summary: >-
How much of a contract's value the claims against it have used, against
what the agreement is
description: >-
worth.
`consumed` is what the vendor has agreed to absorb, `committed` what has
been asked for and not yet
answered; they are separate because adding them would answer neither
question. Every amount is in
`currency_code`, resolved once for the tenant, and `unconverted_claims`
counts claims left out of
the totals because no rate covered their currency on the day.
`percent_consumed` is null where the
contract carries no value to divide by — `has_value` says which case it
is.
parameters:
- $ref: '#/components/parameters/rowFilter.contract_value_usage.contract_id'
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.contract_number
- $ref: '#/components/parameters/rowFilter.contract_value_usage.contract_name'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.vendor_id'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.vendor_name'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.start_date'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.end_date'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.currency_code'
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.currency_symbol
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.currency_decimal_places
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.contract_value
- $ref: '#/components/parameters/rowFilter.contract_value_usage.consumed'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.committed'
- $ref: '#/components/parameters/rowFilter.contract_value_usage.remaining'
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.remaining_after_committed
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.percent_consumed
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.percent_committed
- $ref: '#/components/parameters/rowFilter.contract_value_usage.has_value'
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.consumed_claims
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.committed_claims
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.uncounted_claims
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.unconverted_claims
- $ref: '#/components/parameters/rowFilter.contract_value_usage.is_over_value'
- $ref: >-
#/components/parameters/rowFilter.contract_value_usage.is_over_value_with_committed
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/order'
- $ref: '#/components/parameters/range'
- $ref: '#/components/parameters/rangeUnit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/preferCount'
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/contract_value_usage'
type: array
application/vnd.pgrst.object+json:
schema:
items:
$ref: '#/components/schemas/contract_value_usage'
type: array
application/vnd.pgrst.object+json;nulls=stripped:
schema:
items:
$ref: '#/components/schemas/contract_value_usage'
type: array
text/csv:
schema:
items:
$ref: '#/components/schemas/contract_value_usage'
type: array
description: OK
'206':
description: Partial Content
components:
parameters:
rowFilter.contract_value_usage.contract_id:
in: query
name: contract_id
required: false
schema:
type: string
rowFilter.contract_value_usage.contract_number:
in: query
name: contract_number
required: false
schema:
type: string
rowFilter.contract_value_usage.contract_name:
in: query
name: contract_name
required: false
schema:
type: string
rowFilter.contract_value_usage.vendor_id:
in: query
name: vendor_id
required: false
schema:
type: string
rowFilter.contract_value_usage.vendor_name:
in: query
name: vendor_name
required: false
schema:
type: string
rowFilter.contract_value_usage.start_date:
in: query
name: start_date
required: false
schema:
type: string
rowFilter.contract_value_usage.end_date:
in: query
name: end_date
required: false
schema:
type: string
rowFilter.contract_value_usage.currency_code:
in: query
name: currency_code
required: false
schema:
type: string
rowFilter.contract_value_usage.currency_symbol:
in: query
name: currency_symbol
required: false
schema:
type: string
rowFilter.contract_value_usage.currency_decimal_places:
in: query
name: currency_decimal_places
required: false
schema:
type: string
rowFilter.contract_value_usage.contract_value:
in: query
name: contract_value
required: false
schema:
type: string
rowFilter.contract_value_usage.consumed:
in: query
name: consumed
required: false
schema:
type: string
rowFilter.contract_value_usage.committed:
in: query
name: committed
required: false
schema:
type: string
rowFilter.contract_value_usage.remaining:
in: query
name: remaining
required: false
schema:
type: string
rowFilter.contract_value_usage.remaining_after_committed:
in: query
name: remaining_after_committed
required: false
schema:
type: string
rowFilter.contract_value_usage.percent_consumed:
in: query
name: percent_consumed
required: false
schema:
type: string
rowFilter.contract_value_usage.percent_committed:
in: query
name: percent_committed
required: false
schema:
type: string
rowFilter.contract_value_usage.has_value:
in: query
name: has_value
required: false
schema:
type: string
rowFilter.contract_value_usage.consumed_claims:
in: query
name: consumed_claims
required: false
schema:
type: string
rowFilter.contract_value_usage.committed_claims:
in: query
name: committed_claims
required: false
schema:
type: string
rowFilter.contract_value_usage.uncounted_claims:
in: query
name: uncounted_claims
required: false
schema:
type: string
rowFilter.contract_value_usage.unconverted_claims:
in: query
name: unconverted_claims
required: false
schema:
type: string
rowFilter.contract_value_usage.is_over_value:
in: query
name: is_over_value
required: false
schema:
type: string
rowFilter.contract_value_usage.is_over_value_with_committed:
in: query
name: is_over_value_with_committed
required: false
schema:
type: string
select:
description: Filtering Columns
in: query
name: select
required: false
schema:
type: string
order:
description: Ordering
in: query
name: order
required: false
schema:
type: string
range:
description: Limiting and Pagination
in: header
name: Range
required: false
schema:
type: string
rangeUnit:
description: Limiting and Pagination
in: header
name: Range-Unit
required: false
schema:
default: items
type: string
offset:
description: Limiting and Pagination
in: query
name: offset
required: false
schema:
type: string
limit:
description: Limiting and Pagination
in: query
name: limit
required: false
schema:
type: string
preferCount:
description: Preference
in: header
name: Prefer
required: false
schema:
enum:
- count=none
type: string
schemas:
contract_value_usage:
description: >-
How much of a contract's value the claims against it have used, against
what the agreement is
worth.
`consumed` is what the vendor has agreed to absorb, `committed` what has
been asked for and not yet
answered; they are separate because adding them would answer neither
question. Every amount is in
`currency_code`, resolved once for the tenant, and `unconverted_claims`
counts claims left out of
the totals because no rate covered their currency on the day.
`percent_consumed` is null where the
contract carries no value to divide by — `has_value` says which case it
is.
properties:
committed:
format: numeric
type: number
committed_claims:
format: bigint
type: integer
consumed:
format: numeric
type: number
consumed_claims:
format: bigint
type: integer
contract_id:
description: |-
Note:
This is a Primary Key.
format: uuid
type: string
contract_name:
format: character varying
maxLength: 200
type: string
contract_number:
format: character varying
maxLength: 60
type: string
contract_value:
format: numeric
type: number
currency_code:
format: character varying
maxLength: 3
type: string
currency_decimal_places:
format: smallint
type: integer
currency_symbol:
format: character varying
maxLength: 10
type: string
end_date:
format: date
type: string
has_value:
format: boolean
type: boolean
is_over_value:
format: boolean
type: boolean
is_over_value_with_committed:
format: boolean
type: boolean
percent_committed:
format: numeric
type: number
percent_consumed:
format: numeric
type: number
remaining:
format: numeric
type: number
remaining_after_committed:
format: numeric
type: number
start_date:
format: date
type: string
unconverted_claims:
format: bigint
type: integer
uncounted_claims:
format: bigint
type: integer
vendor_id:
description: >-
Note:
This is a Foreign Key to `assignable_vendors.id`.
format: uuid
type: string
vendor_name:
format: character varying
maxLength: 200
type: string
type: object
````