TermsAmendmentOutput

What the save did.

The calculated values are deliberately not repeated here: the client already has them from the preview it ran immediately before, and GET /contracts/{id} returns the recomputed persisted figures.

  • contractId
    Type: string
    required

    Contract ID

  • effectiveDate
    Type: stringFormat: date-time
    required

    When these terms take effect

  • isPending
    Type: boolean
    required

    True when the amendment is future-dated and has not been applied yet. The contract's reported figures are unchanged until it is

  • versionId
    Type: string
    required

    Terms version ID (ctv-)

  • versionIndex
    Type: integer
    required

    Monotonic index of this version within the contract; 0 is the initial terms

  • appliedAt
    Type: stringFormat: date-timenullable

    When the version became the live terms. Null while it is still pending

  • servicesCreated
    Type: integer

    Service lines the amendment added

  • servicesDeleted
    Type: integer

    Service lines the amendment removed

  • servicesUpdated
    Type: integer

    Service lines the amendment changed