TermsVersionSummary

One entry in the terms history timeline (CRM-9355).

Every figure is read from the columns frozen onto the version row at save time — nothing here is recomputed. A version has to keep reporting what it was worth after the services it referenced were repriced or deleted, and a timeline that re-derived its numbers would rewrite history whenever the rollup logic changed.

  • isPending
    Type: boolean
    required

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

  • status
    Type: enum
    required

    APPLIED, PENDING or WITHDRAWN. Branch on this rather than isPending — a withdrawn version is neither applied nor still coming

    values
    APPLIEDPENDINGWITHDRAWN
  • versionId
    Type: string
    required

    Terms version ID (ctv-)

  • versionIndex
    Type: integer
    required

    Position in the contract's own sequence; 0 is the initial terms

  • amendmentReason
    Type: stringnullable

    Free-text reason. Null on the initial terms, which nobody authored

  • appliedAt
    Type: stringFormat: date-timenullable

    When this version became the live terms. Null while pending

  • cancellationReason
    Type: stringnullable

    Why it was withdrawn — a correction writes no version of its own, so this is the only record of what cancelled this one

  • cancelledAt
    Type: stringFormat: date-timenullable

    When this amendment was withdrawn. Null unless status is WITHDRAWN

  • cancelledBy
    Type: stringnullable

    User ID of whoever withdrew it

  • cancelledByName
    Type: stringnullable

    Display name of whoever withdrew it, resolved so the timeline needs no second call

  • createdAt
    Type: stringFormat: date-timenullable

    When the version was saved

  • createdBy
    Type: stringnullable

    User ID of the author

  • createdByName
    Type: stringnullable

    Author's display name, resolved so the timeline needs no second call

  • currency
    Type: stringnullable

    Contract currency at this version

  • effectiveDate
    Type: stringFormat: date-timenullable

    When these terms take effect

  • effectiveUntil
    Type: stringFormat: date-timenullable

    When the next version takes over. Null on the newest entry, whose terms are still in force

  • servicesCount
    Type: integernullable

    Number of services at this version

  • totalContractValue
    Type: numbernullable

    Frozen TCV

  • totalContractValueChange
    Type: numbernullable

    TCV difference against the previous version. Null on the initial terms, and null when either side has no figure

  • totalContractValueLocal
    Type: numbernullable

    Frozen TCV in the contract currency

  • totalContractValueLocalChange
    Type: numbernullable

    The same difference in the contract currency