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

# Get revenue recognition waterfall

> Aggregate revenue-recognition schedules into a booked-by-recognition month matrix.



## OpenAPI

````yaml get /v1/accounting/revrec/waterfall
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/revrec/waterfall:
    get:
      tags:
        - Accounting > Revenue recognition
      summary: Get revenue recognition waterfall
      description: >-
        Aggregate revenue-recognition schedules into a booked-by-recognition
        month matrix.
      operationId: getRevRecWaterfall
      parameters:
        - schema:
            type: string
            description: Ledger identifier.
          required: true
          description: Ledger identifier.
          name: ledger_id
          in: query
        - schema:
            type: integer
            minimum: 2000
            maximum: 2100
            description: Booked calendar year.
          required: true
          description: Booked calendar year.
          name: year
          in: query
        - schema:
            type: string
            description: Comma-separated customer identifiers.
          required: false
          description: Comma-separated customer identifiers.
          name: customer_id__in
          in: query
        - schema:
            type: string
            description: Comma-separated product identifiers.
          required: false
          description: Comma-separated product identifiers.
          name: product_id__in
          in: query
        - schema:
            type: string
            description: Search customer, product, invoice, or schedule data.
          required: false
          description: Search customer, product, invoice, or schedule data.
          name: search
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingRevRecWaterfall'
      security:
        - bearer: []
components:
  schemas:
    AccountingRevRecWaterfall:
      type: object
      properties:
        currency:
          type: string
          description: ISO 4217 ledger currency.
        columns:
          type: array
          items:
            type: string
          description: Recognition months displayed by the waterfall.
        rows:
          type: array
          items:
            type: object
            properties:
              booked_total:
                type: number
                description: Total amount booked in the row.
              by_month:
                type: object
                additionalProperties:
                  type: object
                  properties:
                    recognized:
                      type: number
                      description: Amount already recognized.
                    remaining:
                      type: number
                      description: Amount remaining to recognize.
                  required:
                    - recognized
                    - remaining
                description: Recognition values keyed by month.
              recognized_total:
                type: number
                description: Total amount recognized in the row.
              remaining:
                type: number
                description: Total amount remaining in the row.
              booked_month:
                type: string
                description: Month in which revenue was booked.
            required:
              - booked_total
              - by_month
              - recognized_total
              - remaining
              - booked_month
          description: Waterfall rows grouped by booked month.
        totals:
          type: object
          properties:
            booked_total:
              type: number
              description: Total amount booked in the row.
            by_month:
              type: object
              additionalProperties:
                type: object
                properties:
                  recognized:
                    type: number
                    description: Amount already recognized.
                  remaining:
                    type: number
                    description: Amount remaining to recognize.
                required:
                  - recognized
                  - remaining
              description: Recognition values keyed by month.
            recognized_total:
              type: number
              description: Total amount recognized in the row.
            remaining:
              type: number
              description: Total amount remaining in the row.
          required:
            - booked_total
            - by_month
            - recognized_total
            - remaining
          description: Totals across all waterfall rows.
      required:
        - currency
        - columns
        - rows
        - totals
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````