ContractInfoOutput

Output model for contract responses.

  • csmRenewalConfidenceLevelLabel
    Type: string
    read-only
    required
  • durationDisplay
    Type: string
    read-only
    required
  • id
    Type: string
    max length:  
    50
    required

    Unique identifier for the contract

  • onboardingStageName
    Type: stringnullable
    read-only
    required
  • onboardingStatus
    Type: string
    read-only
    required
  • percentageFromCsmRenewalBook
    Type: numbernullable
    read-only
    required
  • period
    Type: string
    read-only
    required
  • serviceCount
    Type: integernullable
    read-only
    required

    Integer numbers.

  • aeOwner
    Type: string
    max length:  
    50    nullable

    Account Executive owner ID

  • annualContractValue
    Type: numbernullable

    Annual contract value

  • annualContractValueLocal
    Type: numbernullable

    Annual contract value in local currency

  • arr
    Type: numbernullable

    Annual Recurring Revenue

  • arrLocal
    Type: numbernullable

    Annual Recurring Revenue in local currency

  • automaticallyAddedPartnerContacts
    Type: array of stringnullable

    Partner contacts automatically added to this contract

  • automaticallyAddedPeople
    Type: array of stringnullable

    People automatically added to this contract

  • calculatedAnnualContractValue
    Type: numbernullable

    Calculated ACV from revenue items (read-only, never overwritten by financial_override)

  • calculatedAnnualContractValueLocal
    Type: numbernullable

    Calculated ACV in local currency from revenue items (read-only)

  • calculatedArr
    Type: numbernullable

    Calculated ARR from revenue items (read-only, never overwritten by financial_override)

  • calculatedArrLocal
    Type: numbernullable

    Calculated ARR in local currency from revenue items (read-only)

  • calculatedCarr
    Type: numbernullable

    Calculated CARR from service items (read-only, computed from services)

  • calculatedCarrLocal
    Type: numbernullable

    Calculated CARR in local currency from service items (read-only)

  • calculatedCmrr
    Type: numbernullable

    Calculated CMRR from service items (read-only, computed from services)

  • calculatedCmrrLocal
    Type: numbernullable

    Calculated CMRR in local currency from service items (read-only)

  • calculatedMrr
    Type: numbernullable

    Calculated MRR from revenue items (read-only, never overwritten by financial_override)

  • calculatedMrrLocal
    Type: numbernullable

    Calculated MRR in local currency from revenue items (read-only)

  • calculatedTotalContractValue
    Type: numbernullable

    Calculated TCV from revenue items (read-only, never overwritten by financial_override)

  • calculatedTotalContractValueLocal
    Type: numbernullable

    Calculated TCV in local currency from revenue items (read-only)

  • carr
    Type: numbernullable

    Committed Annual Recurring Revenue (manual override)

  • carrLocal
    Type: numbernullable

    Committed Annual Recurring Revenue in local currency (manual override, editable)

  • cmrr
    Type: numbernullable

    Committed Monthly Recurring Revenue (manual override)

  • cmrrLocal
    Type: numbernullable

    Committed Monthly Recurring Revenue in local currency (manual override, editable)

  • companyId
    Type: string
    max length:  
    50    nullable

    Identifier of the associated company

  • createdAt
    Type: stringFormat: date-timenullable

    Creation timestamp

  • csmOwner
    Type: string
    max length:  
    50    nullable

    Customer Success Manager owner ID

  • csmRenewalConfidenceLevel
    Type: integernullable

    CSM renewal confidence level ID (1=Low, 2=Medium, 3=High)

  • currency
    Type: string
    max length:  
    4    nullable

    Currency code (e.g., USD, EUR)

  • dealId
    Type: string
    max length:  
    50    nullable

    Identifier of the associated deal (nullable — a contract may exist without a linked deal)

  • duplicatedFromContractId
    Type: string
    max length:  
    50    nullable

    When this contract was created by duplicating another, the id of the source contract; null otherwise

  • duration
    Type: integernullable

    Contract duration in months

  • endDate
    Type: stringFormat: date-timenullable

    Contract end date

  • financialNote
    Type: string
    max length:  
    8192    nullable

    Free-text financial note on the contract

  • financialOverride
    Type: booleannullable

    When true, ARR/MRR/ACV/TCV are manual overrides and not recalculated from services

  • isDeleted
    Type: booleannullable

    Soft delete flag

  • isDetachedFromDeal
    Type: booleannullable

    When true, the contract has been intentionally disconnected from its source deal; deal-driven update flows treat it as read-only

  • manuallyAddedPartnerContacts
    Type: array of stringnullable

    Partner contacts manually added to this contract

  • manuallyAddedPeople
    Type: array of stringnullable

    People manually added to this contract

  • mrr
    Type: numbernullable

    Monthly Recurring Revenue

  • mrrLocal
    Type: numbernullable

    Monthly Recurring Revenue in local currency

  • name
    Type: string
    max length:  
    1024    nullable

    Name of the contract

  • nextOptOut
    Type: stringFormat: date-timenullable

    Closest opt-out date across the contract's services (revenue items)

  • nextRenewal
    Type: stringFormat: date-timenullable

    Next renewal date

  • onboardingCompletedAt
    Type: stringFormat: date-timenullable

    Date when contract onboarding completed

  • onboardingStageId
    Type: string
    max length:  
    50    nullable

    Identifier of the contracts_onboarding_stages row this contract is on

  • onboardingStartDate
    Type: stringFormat: date-timenullable

    Date when contract onboarding started

  • partnerId
    Type: string
    max length:  
    50    nullable

    Identifier of the associated partner (channel/referral partner)

  • productId
    Type: string
    max length:  
    50    nullable

    Identifier of the associated product

  • renewalType
    Type: integernullable

    Renewal type ID

  • revenueItems
    Type: arraynullable

    Array of revenue item objects with their scheduled payments

  • signedOn
    Type: stringFormat: date-timenullable

    Date when contract was signed

  • snapshotOfDealId
    Type: string
    max length:  
    50    nullable

    When this contract is the frozen per-deal snapshot created at closed_won, the id of that deal; null for live contracts

  • startDate
    Type: stringFormat: date-timenullable

    Contract start date

  • status
    Type: integernullable

    Contract status ID

  • totalContractValue
    Type: numbernullable

    Total contract value

  • totalContractValueLocal
    Type: numbernullable

    Total contract value in local currency

  • uploadFiles
    Type: Uploadfilesnullable

    Arbitrary JSON describing files uploaded against the contract

    Properties: 1
  • propertyName
    additionalPropertyType: anything