> ## 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 accounting overview

> Get the revenue recognition overview of a ledger for a year: recognized, scheduled and net billed amounts by month, deferred and unbilled revenue rollforwards, remaining revenue by product and timing, contracts by status and what needs attention.



## OpenAPI

````yaml get /v1/accounting/overview
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/overview:
    get:
      tags:
        - Accounting > Revenue recognition
      summary: Get accounting overview
      description: >-
        Get the revenue recognition overview of a ledger for a year: recognized,
        scheduled and net billed amounts by month, deferred and unbilled revenue
        rollforwards, remaining revenue by product and timing, contracts by
        status and what needs attention.
      operationId: getAccountingOverview
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Ledger identifier.
          required: true
          description: Ledger identifier.
          name: ledger_id
          in: query
        - schema:
            type: integer
            minimum: 2000
            maximum: 2100
            description: Calendar year, from 2000 to 2100.
            example: 2026
          required: true
          description: Calendar year, from 2000 to 2100.
          name: year
          in: query
        - schema:
            type: string
            minLength: 1
            description: >-
              Restrict every figure but `attention.first_open_month` to the
              customers of this segment.
          required: false
          description: >-
            Restrict every figure but `attention.first_open_month` to the
            customers of this segment.
          name: customer_segment_id
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingOverview'
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    AccountingOverview:
      type: object
      properties:
        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: Currency of the ledger, in which every amount is.
          example: EUR
        year:
          type: integer
          description: Calendar year of the overview.
          example: 2026
        metrics:
          type: object
          properties:
            recognized:
              type: number
              description: >-
                Revenue recognized over the year: the sum of
                `months[].recognized`.
              example: 12450000
            deferred_revenue:
              type: number
              description: >-
                Deferred revenue at the end of the year: the sum of the
                `closing` steps of the deferred accounts' movements.
              example: 3200000
            unbilled_revenue:
              type: number
              description: >-
                Unbilled revenue at the end of the year: the sum of the
                `closing` steps of the unbilled accounts' movements.
              example: 450000
            remaining_to_recognize:
              type: number
              description: >-
                Revenue left to recognize on the live schedules, today: the sum
                of `timing`.
              example: 8900000
          required:
            - recognized
            - deferred_revenue
            - unbilled_revenue
            - remaining_to_recognize
          description: Headline figures.
        months:
          type: array
          items:
            type: object
            properties:
              month:
                type: string
                pattern: ^\d{4}-(0[1-9]|1[0-2])$
                description: Calendar month, YYYY-MM.
                example: 2026-03
              net_billed:
                type: number
                description: >-
                  Invoices less credit notes emitted in the month (excluding
                  tax), in the ledger currency at the rate of their posting
                  entry. A document without a posting entry on the ledger counts
                  nothing.
              recognized:
                type: number
                description: >-
                  Revenue recognized for the month (recognized slices, by
                  recognition month).
              scheduled:
                type: number
                description: >-
                  Revenue planned for the month and not recognized yet (pending
                  slices).
              is_open:
                type: boolean
                description: Whether the month is after the ledger's last closed month.
            required:
              - month
              - net_billed
              - recognized
              - scheduled
              - is_open
          description: The twelve months of the year, in order.
        movements:
          type: array
          items:
            type: object
            properties:
              ledger_account:
                type: object
                properties:
                  id:
                    type: string
                    description: Identifier of the ledger account.
                    example: lac_2Lm9xQ1z4Ha7Gk
                  code:
                    type: string
                    description: Code of the ledger account.
                    example: '2100'
                  name:
                    type: string
                    description: Name of the ledger account.
                    example: Deferred revenue
                required:
                  - id
                  - code
                  - name
                description: Ledger account of the rollforward.
              type:
                type: string
                enum:
                  - deferred
                  - unbilled
                description: >-
                  `deferred` for a deferred revenue (contract liability)
                  account, `unbilled` for an unbilled revenue (contract asset)
                  account.
              steps:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                      enum:
                        - opening
                        - billing
                        - recognition
                        - credit_notes
                        - accrued
                        - invoiced
                        - other
                        - closing
                      description: >-
                        `opening` (balance at the start of the year), `billing`
                        (invoices posted to a deferred account), `recognition`
                        (revenue recognized out of a deferred account),
                        `credit_notes`, `accrued` (revenue recognized into an
                        unbilled account), `invoiced` (invoices and credit notes
                        clearing an unbilled account), `other` (manual and other
                        entries), `closing` (balance at the end of the year).
                    amount:
                      type: number
                      description: >-
                        Movement of the step, signed as the account's balance:
                        positive increases it.
                  required:
                    - key
                    - amount
                description: >-
                  Steps of the rollforward, so that `opening` plus the steps
                  between equals `closing`.
            required:
              - ledger_account
              - type
              - steps
          description: >-
            Rollforward of each deferred and unbilled revenue account over the
            year, from posted journal entry lines.
        products:
          type: array
          items:
            type: object
            properties:
              product_id:
                type:
                  - string
                  - 'null'
                description: Identifier of the product, or null for the `other` row.
                example: itm_4Ha7Gk2Lm9xQ1z
              name:
                type:
                  - string
                  - 'null'
                description: Name of the product, or null for the `other` row.
              recognized:
                type: number
                description: Revenue recognized so far on its schedules.
              remaining:
                type: number
                description: Revenue left to recognize on its schedules.
            required:
              - product_id
              - name
              - recognized
              - remaining
          description: >-
            Revenue recognized and remaining by product on the live schedules:
            the top products, then one `other` row (null `product_id`) folding
            the rest and the schedules with no product.
        timing:
          type: object
          properties:
            next_12_months:
              type: number
              description: Planned in the next 12 months from today.
            later:
              type: number
              description: Planned after the next 12 months.
            not_scheduled:
              type: number
              description: >-
                Not dated yet: the remainder of a held contract or of an
                event-driven obligation (consumption, milestone).
          required:
            - next_12_months
            - later
            - not_scheduled
          description: Revenue left to recognize, by when it is planned.
        contracts:
          type: object
          properties:
            recognizing:
              type: integer
              description: Contracts recognizing revenue, not fully recognized yet.
            on_hold:
              type: integer
              description: >-
                Contracts whose recognition is held, by a missing input (such as
                a standalone selling price) or a blocking exception.
            to_review:
              type: integer
              description: Contracts waiting for a reviewer's decision.
            rejected:
              type: integer
              description: Contracts whose latest version a reviewer rejected.
            recognized:
              type: integer
              description: Contracts that recognized their whole transaction price.
          required:
            - recognizing
            - on_hold
            - to_review
            - rejected
            - recognized
          description: >-
            Contracts governed by a revenue policy on the ledger, by status; the
            counts sum to those contracts.
        attention:
          type: object
          properties:
            open_issues:
              type: integer
              description: Open accounting exceptions of the ledger's contracts.
            to_mark_delivered:
              type: integer
              description: >-
                Allocated `milestone` obligations of applied contracts not
                delivered yet.
            first_open_month:
              type:
                - string
                - 'null'
              pattern: ^\d{4}-(0[1-9]|1[0-2])$
              description: >-
                Month ready to close (YYYY-MM): the month after the last closed
                one, or the month of the ledger's first posted entry when none
                was closed. Null when that month has not ended yet or the ledger
                has no posted entry. Not restricted by `customer_segment_id`.
              example: 2026-03
          required:
            - open_issues
            - to_mark_delivered
            - first_open_month
          description: What needs attention on the ledger.
      required:
        - currency
        - year
        - metrics
        - months
        - movements
        - products
        - timing
        - contracts
        - attention
      description: >-
        Revenue recognition overview of a ledger for a calendar year. Amounts
        are whole minor units of the ledger currency (cents for EUR), rounded so
        every total equals the sum of its parts.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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