TermsVersionDetailOutput

View terms as they stood at one version (CRM-9355).

Self-contained: every value comes from the snapshot tables, with no join back to revenue_items. A version whose services were deleted from the live set months ago still renders in full. Read-only — never an entry point to editing.

  • contractId
    Type: string
    required

    Contract ID

  • financials
    Type:
    required

    The figures frozen at this version

    Properties: 13
  • isPending
    Type: boolean
    required

    True for a future-dated amendment not yet applied and not withdrawn. Kept for clients predating the status field

  • status
    Type: enum
    required

    APPLIED, PENDING or WITHDRAWN

    values
    APPLIEDPENDINGWITHDRAWN
  • versionId
    Type: string
    required

    Terms version ID

  • versionIndex
    Type: integer
    required

    Position in the contract's sequence

  • amendmentReason
    Type: stringnullable

    Free-text reason, if any

  • appliedAt
    Type: stringFormat: date-timenullable

    When they became live. Null while pending

  • cancellationReason
    Type: stringnullable

    Why it was withdrawn

  • cancelledAt
    Type: stringFormat: date-timenullable

    When this amendment was withdrawn, if it was

  • cancelledBy
    Type: stringnullable

    User ID of whoever withdrew it

  • createdAt
    Type: stringFormat: date-timenullable

    When the version was saved

  • createdBy
    Type: stringnullable

    User ID of the author

  • effectiveDate
    Type: stringFormat: date-timenullable

    When these terms take effect

  • items
    Type: array of TermsVersionItemOutput

    The frozen service lines, in display order

    Properties: 20