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

# Override contract assessment input

> Record a reviewer's override on a contract (a standalone selling price, an obligation treatment, allocated amounts or consumption units), with a reason, replacing a live override of the same subject until revoked; the contract is re-assessed.



## OpenAPI

````yaml post /v1/accounting/contract-assessments/{id}/overrides
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/{id}/overrides:
    post:
      tags:
        - Accounting > Revenue policies
      summary: Override contract assessment input
      description: >-
        Record a reviewer's override on a contract (a standalone selling price,
        an obligation treatment, allocated amounts or consumption units), with a
        reason, replacing a live override of the same subject until revoked; the
        contract is re-assessed.
      operationId: createContractAssessmentOverride
      parameters:
        - schema:
            type: string
          required: true
          name: id
          in: path
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                override:
                  $ref: '#/components/schemas/AccountingOverride'
                reason:
                  type: string
                  minLength: 1
                  description: Why the decision was taken. Required, not empty.
                  example: Price confirmed by the pricing committee.
              required:
                - override
                - reason
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractAssessmentDetail'
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  schemas:
    AccountingOverride:
      oneOf:
        - $ref: '#/components/schemas/AccountingStandaloneSellingPriceOverride'
        - $ref: '#/components/schemas/AccountingObligationTreatmentOverride'
        - $ref: '#/components/schemas/AccountingAllocatedAmountsOverride'
        - $ref: '#/components/schemas/AccountingConsumptionUnitsOverride'
      discriminator:
        propertyName: type
        mapping:
          standalone_selling_price: '#/components/schemas/AccountingStandaloneSellingPriceOverride'
          obligation_treatment: '#/components/schemas/AccountingObligationTreatmentOverride'
          allocated_amounts: '#/components/schemas/AccountingAllocatedAmountsOverride'
          consumption_units: '#/components/schemas/AccountingConsumptionUnitsOverride'
      description: >-
        What the reviewer changes on the contract. Applies to every later
        assessment version until revoked.
    ContractAssessmentDetail:
      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'
        version:
          $ref: '#/components/schemas/ContractAssessmentVersion'
        obligations:
          type: array
          items:
            $ref: '#/components/schemas/PerformanceObligation'
          description: Performance obligations of the version, in order.
        exceptions:
          type: array
          items:
            $ref: '#/components/schemas/AccountingException'
          description: Open exceptions of the contract.
        decisions:
          type: array
          items:
            $ref: '#/components/schemas/AccountingReviewDecision'
          description: Review decisions on the contract, newest first.
        versions:
          type: array
          items:
            type: object
            properties:
              version:
                type: integer
                description: Version number of the assessment.
              change_kind:
                type: string
                enum:
                  - initial
                  - amendment
                  - cancellation
                  - billing_variance
                  - input_update
                  - transition
                description: >-
                  What produced the version: the initial assessment, an
                  amendment, a cancellation, an invoice billing another amount
                  than planned, a changed input (standalone selling price or
                  override), or the transition of a contract already recognized
                  another way.
              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.
              applied_at:
                type:
                  - string
                  - 'null'
                format: date-time
                description: When the version started driving recognition, or null.
                example: '2024-12-20T16:04:11Z'
              created_at:
                type: string
                format: date-time
                description: When the record was created.
                example: '2024-12-20T16:04:11Z'
            required:
              - version
              - change_kind
              - review_status
              - recognition_status
              - applied_at
              - created_at
          description: Every version of the assessment, newest first.
      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
        - version
        - obligations
        - exceptions
        - decisions
        - versions
    AccountingStandaloneSellingPriceOverride:
      type: object
      properties:
        type:
          type: string
          enum:
            - standalone_selling_price
          description: What the override changes.
        obligation_key:
          type: string
          minLength: 1
          description: Obligation the override applies to.
          example: platform
        amount:
          type: number
          minimum: 0
          description: >-
            Standalone selling price of the obligation for the whole contract
            term. Expressed in currency's smallest unit.
          example: 1200000
        evidence_method:
          type: string
          enum:
            - observable_price
            - adjusted_market_assessment
            - expected_cost_plus_margin
            - residual
          description: >-
            How the price was established: observable price, adjusted market
            assessment, expected cost plus margin, or residual approach.
        evidence_note:
          type:
            - string
            - 'null'
          description: Free-text justification of the price, or null.
      required:
        - type
        - obligation_key
        - amount
        - evidence_method
        - evidence_note
      additionalProperties: false
      title: Standalone selling price
    AccountingObligationTreatmentOverride:
      type: object
      properties:
        type:
          type: string
          enum:
            - obligation_treatment
          description: What the override changes.
        obligation_key:
          type: string
          minLength: 1
          description: Obligation the override applies to.
          example: platform
        treatment:
          type: string
          enum:
            - allocated
            - excluded
          description: Treatment the obligation takes.
      required:
        - type
        - obligation_key
        - treatment
      additionalProperties: false
      title: Obligation treatment
    AccountingAllocatedAmountsOverride:
      type: object
      properties:
        type:
          type: string
          enum:
            - allocated_amounts
          description: What the override changes.
        amounts:
          type: array
          items:
            type: object
            properties:
              obligation_key:
                type: string
                minLength: 1
                description: Obligation the override applies to.
                example: platform
              amount:
                type: number
                minimum: 0
                description: >-
                  Amount allocated to the obligation. Expressed in currency's
                  smallest unit.
            required:
              - obligation_key
              - amount
          minItems: 1
          description: >-
            Allocated amount of every allocated obligation, summing to the
            transaction price.
      required:
        - type
        - amounts
      additionalProperties: false
      title: Allocated amounts
    AccountingConsumptionUnitsOverride:
      type: object
      properties:
        type:
          type: string
          enum:
            - consumption_units
          description: What the override changes.
        obligation_key:
          type: string
          minLength: 1
          description: Obligation the override applies to.
          example: platform
        expected_units:
          type: number
          minimum: 0
          description: Units the obligation entitles to over the term.
          example: 100000
      required:
        - type
        - obligation_key
        - expected_units
      additionalProperties: false
      title: Consumption units
    ContractAssessmentVersion:
      type: object
      properties:
        version:
          type: integer
          description: Version number of the assessment.
        change_kind:
          type: string
          enum:
            - initial
            - amendment
            - cancellation
            - billing_variance
            - input_update
            - transition
          description: >-
            What produced the version: the initial assessment, an amendment, a
            cancellation, an invoice billing another amount than planned, a
            changed input (standalone selling price or override), or the
            transition of a contract already recognized another way.
        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.
        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.
        allocation_method:
          type: string
          enum:
            - relative_ssp
            - commercial_price
            - manual
          description: >-
            Allocation method of the version: `relative_ssp`,
            `commercial_price`, or `manual` when an override set the amounts.
        allocation_rounding:
          type: object
          properties:
            remainder:
              type: number
              description: >-
                Remainder the proportional shares left. Expressed in currency's
                smallest unit.
            adjustments:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    description: Obligation key.
                  amount:
                    type: number
                    description: >-
                      Amount the obligation absorbed. Expressed in currency's
                      smallest unit.
                required:
                  - key
                  - amount
              description: Obligations that absorbed the remainder.
          required:
            - remainder
            - adjustments
          description: >-
            How the minor-unit remainder of the proportional allocation was
            settled.
        steps:
          type: object
          properties:
            contract:
              $ref: '#/components/schemas/ContractAssessmentStep'
            performance_obligations:
              $ref: '#/components/schemas/ContractAssessmentStep'
            transaction_price:
              $ref: '#/components/schemas/ContractAssessmentStep'
            allocation:
              $ref: '#/components/schemas/ContractAssessmentStep'
            recognition:
              $ref: '#/components/schemas/ContractAssessmentStep'
          required:
            - contract
            - performance_obligations
            - transaction_price
            - allocation
            - recognition
          description: >-
            The five steps of IFRS 15 / ASC 606 for this version: what was
            determined, from what, and by whom. A complete record is not a
            certification of compliance.
        applied_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the version started driving recognition, or null.
          example: '2024-12-20T16:04:11Z'
        created_at:
          type: string
          format: date-time
          description: When the record was created.
          example: '2024-12-20T16:04:11Z'
      required:
        - version
        - change_kind
        - calculation_status
        - review_status
        - recognition_status
        - currency
        - transaction_price
        - allocation_method
        - allocation_rounding
        - steps
        - applied_at
        - created_at
      description: >-
        The assessment version shown: the latest one unless another was
        requested.
    PerformanceObligation:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the performance obligation.
        key:
          type: string
          description: Stable identifier of the obligation across versions.
          example: platform
        name:
          type: string
          description: Name of the obligation.
        kind:
          type: string
          enum:
            - service_period
            - consumption
            - point_in_time
            - milestone
          description: >-
            How the obligation is delivered: `service_period` over its service
            periods, `consumption` as its units are consumed, `point_in_time` at
            the start of its first service period, `milestone` on the day a
            reviewer records its delivery. For an `allocated` obligation the
            kind sets when it is recognized; its products' accounting rules only
            supply the accounts.
        treatment:
          type: string
          enum:
            - allocated
            - excluded
          description: >-
            `allocated` takes a share of the transaction price; `excluded` keeps
            its commercial amount and the recognition it has without a policy.
        sequence:
          type: integer
          description: Position of the obligation in the assessment.
        product_ids:
          type: array
          items:
            type: string
          description: Products forming the obligation.
        products:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
                description: Identifier of the product.
              name:
                type:
                  - string
                  - 'null'
                description: Name of the product, or null when unknown.
              commercial_amount:
                type: number
                description: >-
                  Amount the contract commits for it. Expressed in currency's
                  smallest unit.
              allocated_amount:
                type:
                  - number
                  - 'null'
                description: >-
                  Share of the transaction price allocated to it, or null while
                  not allocated. Expressed in currency's smallest unit.
            required:
              - product_id
              - name
              - commercial_amount
              - allocated_amount
          description: >-
            Products of the obligation with their commercial and allocated
            amounts.
        commercial_amount:
          type: number
          description: >-
            Amount the contract commits for it. Expressed in currency's smallest
            unit.
        standalone_selling_price_amount:
          type:
            - number
            - 'null'
          description: >-
            Standalone selling price of the obligation for the term, or null
            when unknown. Expressed in currency's smallest unit.
        allocated_amount:
          type:
            - number
            - 'null'
          description: >-
            Share of the transaction price allocated to it, or null while not
            allocated. Expressed in currency's smallest unit.
        recognized_amount:
          type: number
          description: >-
            Revenue its schedules recognized so far, in the contract currency.
            Expressed in currency's smallest unit.
        delivered_on:
          type:
            - string
            - 'null'
          description: >-
            Local day (customer timezone, YYYY-MM-DD) a `milestone` obligation
            was recorded delivered, or null until then and for any other kind.
        recognition:
          $ref: '#/components/schemas/PerformanceObligationRecognition'
        schedules:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Unique identifier of the revenue recognition schedule.
              name:
                type:
                  - string
                  - 'null'
                description: Name of the schedule's product, or null when unknown.
              status:
                type: string
                enum:
                  - pending
                  - in_progress
                  - completed
                  - cancelled
                description: Status of the revenue recognition schedule.
              total_amount:
                type: number
                description: >-
                  Amount the schedule recognizes over its life, net of
                  cancellations, in the contract currency. Expressed in
                  currency's smallest unit.
              recognized_amount:
                type: number
                description: >-
                  Revenue the schedule recognized so far, in the contract
                  currency. Expressed in currency's smallest unit.
            required:
              - id
              - name
              - status
              - total_amount
              - recognized_amount
          description: >-
            Live revenue recognition schedules recognizing the obligation. Only
            the obligations of the applied version have some.
      required:
        - id
        - key
        - name
        - kind
        - treatment
        - sequence
        - product_ids
        - products
        - commercial_amount
        - standalone_selling_price_amount
        - allocated_amount
        - recognized_amount
        - delivered_on
        - recognition
        - schedules
    AccountingException:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the accounting exception.
          example: acx_9xQ1z4Ha7Gk2Lm
        assessment_id:
          type: string
          description: Contract assessment the exception belongs to.
          example: caa_2Lm9xQ1z4Ha7Gk
        assessment_version:
          type: integer
          description: Assessment version that raised the exception.
        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
        code:
          type: string
          enum:
            - missing_standalone_selling_price
            - standalone_selling_price_not_normalizable
            - unmapped_product
            - zero_allocation_basis
            - discount_exceeds_allocation
            - obligation_not_schedulable
            - recognition_rule_incompatible
            - periods_owned_by_invoice_schedules
            - review_required
            - override_review_required
            - override_out_of_date
            - modification_review_required
            - allocation_below_recognized
            - transition_review_required
            - billing_variance
            - consumption_breakage_review
            - milestone_not_delivered
          description: What the exception is about.
        severity:
          type: string
          enum:
            - blocking
            - informational
          description: >-
            `blocking` holds the contract's recognition until resolved,
            `informational` does not.
        status:
          type: string
          enum:
            - open
            - resolved
            - dismissed
          description: >-
            `open` until a new input, an override, an approval or a dismissal
            resolves it.
        obligation_key:
          type:
            - string
            - 'null'
          description: Obligation the exception is about, or null for the whole contract.
        product_ids:
          type: array
          items:
            type: string
          description: Products the exception is about.
        evidence:
          type: object
          additionalProperties: {}
          description: >-
            Data the exception was raised from. Informational: its keys depend
            on the code and may grow.
        proposed_resolution:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: >-
            Suggested way to resolve the exception, or null. Informational: its
            keys depend on the code.
        compatibility_key:
          type: string
          description: >-
            Exceptions sharing this key can be decided together in one bulk
            decision.
        decision_id:
          type:
            - string
            - 'null'
          description: Review decision that resolved it, or null.
        resolved_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the exception was resolved, or null while open.
          example: '2024-12-20T16:04:11Z'
        created_at:
          type: string
          format: date-time
          description: When the record was created.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - assessment_id
        - assessment_version
        - subscription_id
        - customer_id
        - code
        - severity
        - status
        - obligation_key
        - product_ids
        - evidence
        - proposed_resolution
        - compatibility_key
        - decision_id
        - resolved_at
        - created_at
    AccountingReviewDecision:
      oneOf:
        - $ref: '#/components/schemas/AccountingVersionReviewDecision'
        - $ref: '#/components/schemas/AccountingOverrideReviewDecision'
        - $ref: '#/components/schemas/AccountingDeliveryReviewDecision'
      discriminator:
        propertyName: kind
        mapping:
          approval: '#/components/schemas/AccountingVersionReviewDecision'
          rejection: '#/components/schemas/AccountingVersionReviewDecision'
          exception_dismissal: '#/components/schemas/AccountingVersionReviewDecision'
          override: '#/components/schemas/AccountingOverrideReviewDecision'
          delivery: '#/components/schemas/AccountingDeliveryReviewDecision'
    ContractAssessmentStep:
      type: object
      properties:
        determination:
          type: string
          description: What the step determined.
        decided_by:
          type: string
          enum:
            - policy
            - manual
            - system
          description: >-
            Who decided the step: the `policy`, a reviewer (`manual`) or the
            `system`.
        decision_ids:
          type: array
          items:
            type: string
          description: Review decisions the step relies on.
        evidence:
          type: object
          additionalProperties: {}
          description: >-
            Data the step was decided from. Informational: its keys depend on
            the step and may grow.
        is_complete:
          type: boolean
          description: Whether the step could be completed.
      required:
        - determination
        - decided_by
        - decision_ids
        - evidence
        - is_complete
      description: One step of the assessment.
    PerformanceObligationRecognition:
      oneOf:
        - $ref: '#/components/schemas/PerformanceObligationServicePeriodRecognition'
        - $ref: '#/components/schemas/PerformanceObligationConsumptionRecognition'
        - $ref: '#/components/schemas/PerformanceObligationPointInTimeRecognition'
        - $ref: '#/components/schemas/PerformanceObligationMilestoneRecognition'
      discriminator:
        propertyName: kind
        mapping:
          service_period: '#/components/schemas/PerformanceObligationServicePeriodRecognition'
          consumption: '#/components/schemas/PerformanceObligationConsumptionRecognition'
          point_in_time: '#/components/schemas/PerformanceObligationPointInTimeRecognition'
          milestone: '#/components/schemas/PerformanceObligationMilestoneRecognition'
      description: How the obligation is recognized.
    AccountingVersionReviewDecision:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the review decision.
          example: ard_Q1z4Ha7Gk2Lm9x
        kind:
          type: string
          enum:
            - approval
            - rejection
            - exception_dismissal
          description: >-
            `approval`, `rejection`, `override`, `exception_dismissal` or
            `delivery`.
        reason:
          type: string
          description: Why the decision was taken. Required, not empty.
          example: Price confirmed by the pricing committee.
        assessment_version:
          type: integer
          description: >-
            Assessment version the decision is about: the version approved or
            rejected, the one that raised the dismissed exception, or the latest
            one when the delivery was recorded.
        batch_id:
          type:
            - string
            - 'null'
          description: Shared by the decisions of one bulk decision, or null.
        reviewer_user_id:
          type:
            - string
            - 'null'
          description: >-
            User who took the decision, or null when it was taken with an API
            key.
        created_at:
          type: string
          format: date-time
          description: When the record was created.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - kind
        - reason
        - assessment_version
        - batch_id
        - reviewer_user_id
        - created_at
      additionalProperties: false
      title: Approval, rejection or dismissal
    AccountingOverrideReviewDecision:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the review decision.
          example: ard_Q1z4Ha7Gk2Lm9x
        kind:
          type: string
          enum:
            - override
          description: >-
            `approval`, `rejection`, `override`, `exception_dismissal` or
            `delivery`.
        reason:
          type: string
          description: Why the decision was taken. Required, not empty.
          example: Price confirmed by the pricing committee.
        override:
          $ref: '#/components/schemas/AccountingOverride'
        batch_id:
          type:
            - string
            - 'null'
          description: Shared by the decisions of one bulk decision, or null.
        reviewer_user_id:
          type:
            - string
            - 'null'
          description: >-
            User who took the decision, or null when it was taken with an API
            key.
        revoked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the override or delivery was revoked, or null.
          example: '2024-12-20T16:04:11Z'
        created_at:
          type: string
          format: date-time
          description: When the record was created.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - kind
        - reason
        - override
        - batch_id
        - reviewer_user_id
        - revoked_at
        - created_at
      additionalProperties: false
      title: Override
    AccountingDeliveryReviewDecision:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the review decision.
          example: ard_Q1z4Ha7Gk2Lm9x
        kind:
          type: string
          enum:
            - delivery
          description: >-
            `approval`, `rejection`, `override`, `exception_dismissal` or
            `delivery`.
        reason:
          type: string
          description: Why the decision was taken. Required, not empty.
          example: Price confirmed by the pricing committee.
        assessment_version:
          type: integer
          description: >-
            Assessment version the decision is about: the version approved or
            rejected, the one that raised the dismissed exception, or the latest
            one when the delivery was recorded.
        delivery:
          type: object
          properties:
            obligation_key:
              type: string
              description: >-
                Key of the `milestone` obligation delivered, in the contract's
                latest assessment version.
              example: platform
            delivered_on:
              type: string
              description: >-
                Local day (customer timezone, YYYY-MM-DD) the obligation was
                delivered: not in the future, not before the contract term
                starts. Its whole allocated amount is recognized that day (in
                the first open month when that month is closed), once a version
                of the contract is applied. An obligation is delivered once
                until the delivery is revoked; a delivery does not send the
                contract back to review.
              example: '2026-03-31'
          required:
            - obligation_key
            - delivered_on
          description: The delivery recorded.
        batch_id:
          type:
            - string
            - 'null'
          description: Shared by the decisions of one bulk decision, or null.
        reviewer_user_id:
          type:
            - string
            - 'null'
          description: >-
            User who took the decision, or null when it was taken with an API
            key.
        revoked_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the override or delivery was revoked, or null.
          example: '2024-12-20T16:04:11Z'
        created_at:
          type: string
          format: date-time
          description: When the record was created.
          example: '2024-12-20T16:04:11Z'
      required:
        - id
        - kind
        - reason
        - assessment_version
        - delivery
        - batch_id
        - reviewer_user_id
        - revoked_at
        - created_at
      additionalProperties: false
      title: Delivery
    PerformanceObligationServicePeriodRecognition:
      type: object
      properties:
        kind:
          type: string
          enum:
            - service_period
        granularity:
          type:
            - string
            - 'null'
          enum:
            - day
            - month
            - quarter
            - year
          description: >-
            Granularity a `service_period` obligation spreads at, or null for a
            version assessed before obligations carried one.
        products:
          type: array
          items:
            type: object
            properties:
              product_id:
                type: string
                description: Identifier of the product.
              recognition:
                $ref: '#/components/schemas/ContractProductRecognition'
            required:
              - product_id
              - recognition
      required:
        - kind
        - granularity
        - products
      additionalProperties: false
      title: Service period
    PerformanceObligationConsumptionRecognition:
      type: object
      properties:
        kind:
          type: string
          enum:
            - consumption
        expected_units:
          type:
            - number
            - 'null'
          description: >-
            Units the obligation entitles to over the term, or null while
            unknown.
        consumption:
          $ref: '#/components/schemas/RevenuePolicyConsumption'
      required:
        - kind
        - expected_units
        - consumption
      additionalProperties: false
      title: Consumption
    PerformanceObligationPointInTimeRecognition:
      type: object
      properties:
        kind:
          type: string
          enum:
            - point_in_time
        recognition_day:
          type:
            - string
            - 'null'
          description: >-
            Local day (customer timezone, YYYY-MM-DD) a `point_in_time`
            obligation is recognized on: the first day of its first service
            period in the term. Null when unknown.
      required:
        - kind
        - recognition_day
      additionalProperties: false
      title: At service start
    PerformanceObligationMilestoneRecognition:
      type: object
      properties:
        kind:
          type: string
          enum:
            - milestone
      required:
        - kind
      additionalProperties: false
      title: When delivered
    ContractProductRecognition:
      oneOf:
        - $ref: '#/components/schemas/ContractProductSchedulableRecognition'
        - $ref: '#/components/schemas/ContractProductNotSchedulableRecognition'
      discriminator:
        propertyName: status
        mapping:
          schedulable: '#/components/schemas/ContractProductSchedulableRecognition'
          not_schedulable: '#/components/schemas/ContractProductNotSchedulableRecognition'
      description: >-
        The recognition the product's accounting rule resolves to, or why it
        cannot be scheduled.
    RevenuePolicyConsumption:
      oneOf:
        - $ref: '#/components/schemas/RevenuePolicyBreakageAtExpiry'
        - $ref: '#/components/schemas/RevenuePolicyBreakageReview'
        - $ref: '#/components/schemas/RevenuePolicyBreakageProportional'
      discriminator:
        propertyName: breakage
        mapping:
          recognize_at_expiry: '#/components/schemas/RevenuePolicyBreakageAtExpiry'
          review: '#/components/schemas/RevenuePolicyBreakageReview'
          proportional: '#/components/schemas/RevenuePolicyBreakageProportional'
      description: Recognition of consumption obligations.
    ContractProductSchedulableRecognition:
      type: object
      properties:
        status:
          type: string
          enum:
            - schedulable
        method:
          type: string
          description: Revenue recognition method of the accounting rule.
        granularity:
          type:
            - string
            - 'null'
          description: Granularity of the recognition, or null.
        revenue_ledger_account_id:
          type: string
          description: Revenue ledger account.
        deferred_ledger_account_id:
          type: string
          description: Deferred revenue ledger account.
        unbilled_ledger_account_id:
          type: string
          description: Unbilled revenue ledger account.
        revenue_rule_id:
          type:
            - string
            - 'null'
          description: Accounting rule giving the revenue account, or null.
        deferred_rule_id:
          type:
            - string
            - 'null'
          description: Accounting rule giving the deferred revenue account, or null.
        unbilled_rule_id:
          type:
            - string
            - 'null'
          description: Accounting rule giving the unbilled revenue account, or null.
      required:
        - status
        - method
        - granularity
        - revenue_ledger_account_id
        - deferred_ledger_account_id
        - unbilled_ledger_account_id
        - revenue_rule_id
        - deferred_rule_id
        - unbilled_rule_id
      additionalProperties: false
      title: Schedulable
    ContractProductNotSchedulableRecognition:
      type: object
      properties:
        status:
          type: string
          enum:
            - not_schedulable
        reason:
          type: string
          description: Why the product cannot be scheduled.
      required:
        - status
        - reason
      additionalProperties: false
      title: Not schedulable
    RevenuePolicyBreakageAtExpiry:
      type: object
      properties:
        breakage:
          type: string
          enum:
            - recognize_at_expiry
          description: >-
            What an expired, unconsumed entitlement does to revenue:
            `recognize_at_expiry` recognizes it when the grant lapses, `review`
            waits for a reviewer's decision, `proportional` recognizes the
            expected breakage as the grant is consumed (consumed units ÷ (1 −
            expected breakage rate), capped at the grant's units) and the rest
            when it lapses. A grant that never expires only counts its consumed
            units.
      required:
        - breakage
      additionalProperties: false
      title: At expiry
    RevenuePolicyBreakageReview:
      type: object
      properties:
        breakage:
          type: string
          enum:
            - review
          description: >-
            What an expired, unconsumed entitlement does to revenue:
            `recognize_at_expiry` recognizes it when the grant lapses, `review`
            waits for a reviewer's decision, `proportional` recognizes the
            expected breakage as the grant is consumed (consumed units ÷ (1 −
            expected breakage rate), capped at the grant's units) and the rest
            when it lapses. A grant that never expires only counts its consumed
            units.
      required:
        - breakage
      additionalProperties: false
      title: Reviewed
    RevenuePolicyBreakageProportional:
      type: object
      properties:
        breakage:
          type: string
          enum:
            - proportional
          description: >-
            What an expired, unconsumed entitlement does to revenue:
            `recognize_at_expiry` recognizes it when the grant lapses, `review`
            waits for a reviewer's decision, `proportional` recognizes the
            expected breakage as the grant is consumed (consumed units ÷ (1 −
            expected breakage rate), capped at the grant's units) and the rest
            when it lapses. A grant that never expires only counts its consumed
            units.
        expected_breakage_percent:
          type: number
          exclusiveMinimum: 0
          exclusiveMaximum: 100
          description: >-
            Share of an expiring grant expected to lapse unconsumed, in percent,
            greater than 0 and less than 100. Kept by a contract term for the
            version it is assessed under.
          example: 10
      required:
        - breakage
        - expected_breakage_percent
      additionalProperties: false
      title: Proportional
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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