> ## 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.

# What the organisation has declared it is entitled to run: the product, how it is counted

> (metric DEVICE, USER, CONCURRENT, SITE or ENTERPRISE), how many, for how long, from whom and on which
purchase order, how many people a USER entitlement is assigned to, and how many files — the
certificate and anything else attached — back it.



## OpenAPI

````yaml /api-reference/openapi.json get /software_entitlements
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: Data exports
  - name: Directory sync
  - name: Document control
  - name: Document folders
  - name: Document tree
  - name: Documents
  - name: Energy
  - name: Extracts
  - name: Features
  - name: Feeds
  - name: Ffe plans
  - name: File exchange
  - name: Filing exceptions
  - name: Finance
  - name: Inbound mail
  - name: Itam
  - name: Itam software
  - 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: Today
  - name: Tools on a job, and who has them out
  - name: Trackers
  - name: Tray
  - name: Vendor spend forecast
  - name: Vendors and contracts
  - name: Visitors
  - name: Webhooks
  - name: Work order execution
  - name: Work sequencing
  - name: Workforce detail
externalDocs:
  description: PostgREST Documentation
  url: https://postgrest.org/en/v12/references/api.html
paths:
  /software_entitlements:
    get:
      tags:
        - Itam software
      summary: >-
        What the organisation has declared it is entitled to run: the product,
        how it is counted
      description: >-
        (metric DEVICE, USER, CONCURRENT, SITE or ENTERPRISE), how many, for how
        long, from whom and on which

        purchase order, how many people a USER entitlement is assigned to, and
        how many files — the

        certificate and anything else attached — back it.
      parameters:
        - $ref: '#/components/parameters/rowFilter.software_entitlements.id'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.product_id'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.product_name'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.publisher_id'
        - $ref: >-
            #/components/parameters/rowFilter.software_entitlements.publisher_name
        - $ref: '#/components/parameters/rowFilter.software_entitlements.name'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.reference'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.metric'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.quantity'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.site_id'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.site_name'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.starts_on'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.ends_on'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.in_force'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.vendor_id'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.vendor_name'
        - $ref: >-
            #/components/parameters/rowFilter.software_entitlements.purchase_order_id
        - $ref: >-
            #/components/parameters/rowFilter.software_entitlements.purchase_order_number
        - $ref: '#/components/parameters/rowFilter.software_entitlements.notes'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.assigned'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.certificates'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.created_at'
        - $ref: '#/components/parameters/rowFilter.software_entitlements.created_by'
        - $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/software_entitlements'
                type: array
            application/vnd.pgrst.object+json:
              schema:
                items:
                  $ref: '#/components/schemas/software_entitlements'
                type: array
            application/vnd.pgrst.object+json;nulls=stripped:
              schema:
                items:
                  $ref: '#/components/schemas/software_entitlements'
                type: array
            text/csv:
              schema:
                items:
                  $ref: '#/components/schemas/software_entitlements'
                type: array
          description: OK
        '206':
          description: Partial Content
components:
  parameters:
    rowFilter.software_entitlements.id:
      in: query
      name: id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.product_id:
      in: query
      name: product_id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.product_name:
      in: query
      name: product_name
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.publisher_id:
      in: query
      name: publisher_id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.publisher_name:
      in: query
      name: publisher_name
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.name:
      in: query
      name: name
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.reference:
      in: query
      name: reference
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.metric:
      in: query
      name: metric
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.quantity:
      in: query
      name: quantity
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.site_id:
      in: query
      name: site_id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.site_name:
      in: query
      name: site_name
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.starts_on:
      in: query
      name: starts_on
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.ends_on:
      in: query
      name: ends_on
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.in_force:
      in: query
      name: in_force
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.vendor_id:
      in: query
      name: vendor_id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.vendor_name:
      in: query
      name: vendor_name
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.purchase_order_id:
      in: query
      name: purchase_order_id
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.purchase_order_number:
      in: query
      name: purchase_order_number
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.notes:
      in: query
      name: notes
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.assigned:
      in: query
      name: assigned
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.certificates:
      in: query
      name: certificates
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.created_at:
      in: query
      name: created_at
      required: false
      schema:
        type: string
    rowFilter.software_entitlements.created_by:
      in: query
      name: created_by
      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:
    software_entitlements:
      description: >-
        What the organisation has declared it is entitled to run: the product,
        how it is counted

        (metric DEVICE, USER, CONCURRENT, SITE or ENTERPRISE), how many, for how
        long, from whom and on which

        purchase order, how many people a USER entitlement is assigned to, and
        how many files — the

        certificate and anything else attached — back it.
      properties:
        assigned:
          format: bigint
          type: integer
        certificates:
          format: bigint
          type: integer
        created_at:
          format: timestamp with time zone
          type: string
        created_by:
          description: >-
            Note:

            This is a Foreign Key to `capex_invite_candidates.id`.<fk
            table='capex_invite_candidates' column='id'/>
          format: uuid
          type: string
        ends_on:
          format: date
          type: string
        id:
          description: |-
            Note:
            This is a Primary Key.<pk/>
          format: uuid
          type: string
        in_force:
          format: boolean
          type: boolean
        metric:
          format: character varying
          maxLength: 12
          type: string
        name:
          format: character varying
          maxLength: 200
          type: string
        notes:
          format: text
          type: string
        product_id:
          description: >-
            Note:

            This is a Foreign Key to `software_installations.product_id`.<fk
            table='software_installations' column='product_id'/>
          format: uuid
          type: string
        product_name:
          format: character varying
          maxLength: 200
          type: string
        publisher_id:
          description: >-
            Note:

            This is a Foreign Key to `software_installations.publisher_id`.<fk
            table='software_installations' column='publisher_id'/>
          format: uuid
          type: string
        publisher_name:
          format: character varying
          maxLength: 200
          type: string
        purchase_order_id:
          description: >-
            Note:

            This is a Foreign Key to
            `open_purchase_orders.purchase_order_id`.<fk
            table='open_purchase_orders' column='purchase_order_id'/>
          format: uuid
          type: string
        purchase_order_number:
          format: character varying
          maxLength: 60
          type: string
        quantity:
          format: integer
          type: integer
        reference:
          format: character varying
          maxLength: 120
          type: string
        site_id:
          description: >-
            Note:

            This is a Foreign Key to `entry_currencies.for_site_id`.<fk
            table='entry_currencies' column='for_site_id'/>
          format: uuid
          type: string
        site_name:
          format: character varying
          maxLength: 200
          type: string
        starts_on:
          format: date
          type: string
        vendor_id:
          description: >-
            Note:

            This is a Foreign Key to `assignable_vendors.id`.<fk
            table='assignable_vendors' column='id'/>
          format: uuid
          type: string
        vendor_name:
          format: character varying
          maxLength: 200
          type: string
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.