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

# List contract assessments

> List the contract terms assessed under a revenue policy on a ledger, most recently changed first, with the statuses and amounts of their latest version and the contract's billed, recognized, deferred and unbilled totals.



## OpenAPI

````yaml get /v1/accounting/contract-assessments
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/contract-assessments:
    get:
      tags:
        - Accounting > Revenue policies
      summary: List contract assessments
      description: >-
        List the contract terms assessed under a revenue policy on a ledger,
        most recently changed first, with the statuses and amounts of their
        latest version and the contract's billed, recognized, deferred and
        unbilled totals.
      operationId: listContractAssessments
      parameters:
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            maximum: 100
            default: 50
          required: false
          name: take
          in: query
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: skip
          in: query
        - schema:
            type: string
            minLength: 1
            description: Identifier of the ledger the record belongs to.
          required: true
          description: Identifier of the ledger the record belongs to.
          name: ledger_id
          in: query
        - schema:
            type: string
          required: false
          name: id
          in: query
        - schema:
            type: string
          required: false
          name: id__not
          in: query
        - schema:
            type: string
          required: false
          name: id__equals
          in: query
        - schema:
            type: string
          required: false
          name: id__contains
          in: query
        - schema:
            type: string
          required: false
          name: id__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: id__endWith
          in: query
        - schema:
            type: string
            minLength: 1
            description: Identifier of the subscription holding the contract.
          required: false
          description: Identifier of the subscription holding the contract.
          name: subscription_id
          in: query
        - schema:
            type: string
          required: false
          name: subscription_id__not
          in: query
        - schema:
            type: string
          required: false
          name: subscription_id__equals
          in: query
        - schema:
            type: string
          required: false
          name: subscription_id__contains
          in: query
        - schema:
            type: string
          required: false
          name: subscription_id__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: subscription_id__endWith
          in: query
        - schema:
            type: string
            minLength: 1
            description: Only contracts of this customer.
          required: false
          description: Only contracts of this customer.
          name: customer_id
          in: query
        - schema:
            type: string
          required: false
          name: customer_id__not
          in: query
        - schema:
            type: string
          required: false
          name: customer_id__equals
          in: query
        - schema:
            type: string
          required: false
          name: customer_id__contains
          in: query
        - schema:
            type: string
          required: false
          name: customer_id__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: customer_id__endWith
          in: query
        - schema:
            type: string
            minLength: 1
            description: Only contracts pinned to this revenue policy.
          required: false
          description: Only contracts pinned to this revenue policy.
          name: policy_id
          in: query
        - schema:
            type: string
          required: false
          name: policy_id__not
          in: query
        - schema:
            type: string
          required: false
          name: policy_id__equals
          in: query
        - schema:
            type: string
          required: false
          name: policy_id__contains
          in: query
        - schema:
            type: string
          required: false
          name: policy_id__startsWith
          in: query
        - schema:
            type: string
          required: false
          name: policy_id__endWith
          in: query
        - schema:
            type: string
            enum:
              - eligible
              - held
            description: Only contracts whose latest version has this status.
          required: false
          description: Only contracts whose latest version has this status.
          name: recognition_status
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - eligible
                  - held
              - type: string
                description: eligible,held
          required: false
          name: recognition_status__in
          in: query
        - schema:
            type: string
            enum:
              - not_required
              - pending
              - approved
              - rejected
            description: Only contracts whose latest version has this review status.
          required: false
          description: Only contracts whose latest version has this review status.
          name: review_status
          in: query
        - schema:
            anyOf:
              - type: string
                enum:
                  - not_required
                  - pending
                  - approved
                  - rejected
              - type: string
                description: not_required,pending
          required: false
          name: review_status__in
          in: query
        - schema:
            type: string
            description: 'Comma-separated identifiers: only the records with one of them.'
          required: false
          description: 'Comma-separated identifiers: only the records with one of them.'
          name: id__in
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractAssessmentPaginated'
      security:
        - bearer: []
components:
  schemas:
    ContractAssessmentPaginated:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/AccountingPaginationMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/ContractAssessment'
      required:
        - meta
        - data
    AccountingPaginationMeta:
      type: object
      properties:
        total:
          type: number
          description: Total number of matching resources.
        taken:
          type: number
          description: Number of resources returned.
        skipped:
          type: number
          description: Number of resources skipped.
      required:
        - total
        - taken
        - skipped
      description: Pagination metadata.
    ContractAssessment:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the contract assessment.
          example: caa_2Lm9xQ1z4Ha7Gk
        ledger_id:
          type: string
          description: Identifier of the ledger the record belongs to.
          example: led_8Hq2nZ0kLm4x1P
        subscription_id:
          type: string
          description: Identifier of the subscription holding the contract.
          example: sub_Gk2Lm9xQ1z4Ha7
        customer_id:
          type: string
          description: Identifier of the customer.
          example: cus_Lm9xQ1z4Ha7Gk2
        term_start_at:
          type: string
          format: date-time
          description: Start of the assessed contract term.
          example: '2024-12-20T16:04:11Z'
        term_end_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            End of the assessed contract term: the end of its last day in the
            subscription's timezone, or null when the subscription cannot be
            found.
          example: '2024-12-20T16:04:11Z'
        timezone:
          type:
            - string
            - 'null'
          description: >-
            Timezone of the subscription, in which the term's start and end are
            day boundaries, or null when the subscription cannot be found.
          example: Europe/Paris
        policy_id:
          type: string
          description: Revenue policy the contract is assessed under.
          example: rpol_3fJ8kZx1Lq9a2B
        policy_name:
          type: string
          description: Name of the revenue policy.
          example: Enterprise contracts
        policy_version:
          type: integer
          description: Version number of the revenue policy the contract is pinned to.
        latest_version:
          type: integer
          description: Number of the latest assessment version.
        applied_version:
          type:
            - integer
            - 'null'
          description: >-
            Number of the assessment version driving recognition, or null while
            none does.
        currency:
          type: string
          enum:
            - EUR
            - AED
            - AFN
            - XCD
            - ALL
            - AMD
            - AOA
            - ARS
            - USD
            - AUD
            - AWG
            - AZN
            - BAM
            - BBD
            - BDT
            - BGN
            - BHD
            - BIF
            - XOF
            - BMD
            - BND
            - BOB
            - BRL
            - BSD
            - BTN
            - NOK
            - BWP
            - BYR
            - BZD
            - CAD
            - CDF
            - XAF
            - CHF
            - NZD
            - CLP
            - CNY
            - COP
            - CRC
            - CUP
            - CVE
            - ANG
            - CZK
            - DJF
            - DKK
            - DOP
            - DZD
            - EGP
            - MAD
            - ERN
            - ETB
            - FJD
            - FKP
            - GBP
            - GEL
            - GHS
            - GIP
            - GMD
            - GNF
            - GTQ
            - GYD
            - HKD
            - HNL
            - HRK
            - HTG
            - HUF
            - IDR
            - ILS
            - INR
            - IQD
            - IRR
            - ISK
            - JMD
            - JOD
            - JPY
            - KES
            - KGS
            - KHR
            - KMF
            - KPW
            - KRW
            - KWD
            - KYD
            - KZT
            - LAK
            - LBP
            - LKR
            - LRD
            - LSL
            - LYD
            - MDL
            - MGA
            - MKD
            - MMK
            - MNT
            - MOP
            - MRO
            - MUR
            - MVR
            - MWK
            - MXN
            - MYR
            - MZN
            - NAD
            - XPF
            - NGN
            - NIO
            - NPR
            - OMR
            - PAB
            - PEN
            - PGK
            - PHP
            - PKR
            - PLN
            - PYG
            - QAR
            - RON
            - RSD
            - RUB
            - RWF
            - SAR
            - SBD
            - SCR
            - SDG
            - SEK
            - SGD
            - SHP
            - SLL
            - SOS
            - SRD
            - SSP
            - STD
            - SYP
            - SZL
            - THB
            - TJS
            - TMT
            - TND
            - TOP
            - TRY
            - TTD
            - TWD
            - TZS
            - UAH
            - UGX
            - UYU
            - UZS
            - VEF
            - VND
            - VUV
            - WST
            - YER
            - ZAR
            - ZMW
            - ZWL
          description: Contract currency.
          example: EUR
        transaction_price:
          type: number
          description: >-
            Consideration of the contract term allocated across its obligations.
            Expressed in currency's smallest unit.
        invoiced_amount:
          type: number
          description: >-
            Amount billed so far on the contract's revenue recognition
            schedules, net of credit notes and voids, in the contract currency.
            Expressed in currency's smallest unit.
        recognized_amount:
          type: number
          description: >-
            Revenue recognized so far on the contract's revenue recognition
            schedules, in the contract currency. Expressed in currency's
            smallest unit.
        deferred_amount:
          type: number
          description: >-
            Current deferred revenue position of the contract (billed, not yet
            recognized), in the contract currency. Expressed in currency's
            smallest unit.
        unbilled_amount:
          type: number
          description: >-
            Current unbilled revenue position of the contract (recognized, not
            yet billed), in the contract currency. Expressed in currency's
            smallest unit.
        calculation_status:
          type: string
          enum:
            - complete
            - incomplete
          description: >-
            Whether the assessment could be computed, or misses an input such as
            a standalone selling price.
        review_status:
          type: string
          enum:
            - not_required
            - pending
            - approved
            - rejected
          description: Whether the assessment awaits, passed or failed a review.
        recognition_status:
          type: string
          enum:
            - eligible
            - held
          description: >-
            `eligible` when the version may drive recognition, `held` while an
            input, a review or a blocking exception holds it.
        open_exception_count:
          type: integer
          description: Number of open exceptions of the contract.
        updated_at:
          type: string
          format: date-time
          description: When the record last changed.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - ledger_id
        - subscription_id
        - customer_id
        - term_start_at
        - term_end_at
        - timezone
        - policy_id
        - policy_name
        - policy_version
        - latest_version
        - applied_version
        - currency
        - transaction_price
        - invoiced_amount
        - recognized_amount
        - deferred_amount
        - unbilled_amount
        - calculation_status
        - review_status
        - recognition_status
        - open_exception_count
        - updated_at
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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