> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hyperline.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview running contracts of revenue policy

> Estimate how many running contracts a revenue policy would govern, and how many of them already recognized revenue, if its draft (else its latest published version) were published with `include_running_contracts`.



## OpenAPI

````yaml get /v1/accounting/revenue-policies/{id}/running-contracts-preview
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/accounting/revenue-policies/{id}/running-contracts-preview:
    get:
      tags:
        - Accounting > Revenue policies
      summary: Preview running contracts of revenue policy
      description: >-
        Estimate how many running contracts a revenue policy would govern, and
        how many of them already recognized revenue, if its draft (else its
        latest published version) were published with
        `include_running_contracts`.
      operationId: previewRevenuePolicyRunningContracts
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenuePolicyRunningContractsPreview'
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    RevenuePolicyRunningContractsPreview:
      type: object
      properties:
        matching_count:
          type: integer
          description: >-
            Running contracts of the policy's ledger it would govern: current
            term started before the version's effective date, not assessed yet
            on the ledger, and this policy wins the match among the ledger's
            live policies (priority respected). Each would wait for a reviewer's
            approval as a transition. A lower bound when `is_truncated` is true.
          example: 42
        recognized_count:
          type: integer
          description: >-
            Among them, the contracts that already recognized revenue in their
            current term: that revenue stays, only the remainder would follow
            the policy. A lower bound when `is_truncated` is true.
          example: 30
        is_truncated:
          type: boolean
          description: >-
            True when the scan stopped at its cap (2,000 contracts) and more
            contracts were not looked at: both counts are then lower bounds.
          example: false
      required:
        - matching_count
        - recognized_count
        - is_truncated
      description: >-
        Estimate of the running contracts the policy would govern if its draft
        (else its latest published version) were published with
        `include_running_contracts`.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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