ExtendedBaseModel

  • alerts
    Type: array of objectnullable
    read-only
    required

    Get alerts associated with this deal

    Properties: 1
  • allDealPartnerContacts
    Type: array of stringnullable
    read-only
    required
  • allDealPeople
    Type: array of stringnullable
    read-only
    required
  • championsMappingScore
    Type: integernullable
    read-only
    required

    Integer numbers.

  • championsMappingText
    Type: stringnullable
    read-only
    required
  • closedLostReasonName
    Type: stringnullable
    read-only
    required
  • closingQuarter
    Type: stringnullable
    read-only
    required
  • committedArr
    Type: numbernullable
    read-only
    required
  • committedMrr
    Type: numbernullable
    read-only
    required
  • companyName
    Type: stringnullable
    read-only
    required
  • daysInStage
    Type: integernullable
    read-only
    required

    Integer numbers.

  • hasNextSteps
    Type: booleannullable
    read-only
    required
  • id
    Type: string
    min length:  
    1
    required

    deal ID

  • keyStakeholdersMappingScore
    Type: integernullable
    read-only
    required

    Integer numbers.

  • keyStakeholdersMappingText
    Type: stringnullable
    read-only
    required
  • lastActivity
    Type: stringFormat: date-timenullable
    read-only
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • name
    Type: string
    required

    Deal name - A descriptive name for the deal (e.g., 'Acme Corp - Enterprise License')

  • openForDays
    Type: integernullable
    read-only
    required

    Integer numbers.

  • percentageFromOwnerPipelineArr
    Type: numbernullable
    read-only
    required
  • percentageFromOwnerPipelineMrr
    Type: numbernullable
    read-only
    required
  • percentageOfMappedContacts
    Type: numbernullable
    read-only
    required
  • productName
    Type: stringnullable
    read-only
    required
  • qualificationText
    Type: stringnullable
    read-only
    required
  • serviceCount
    Type: integernullable
    read-only
    required

    Integer numbers.

  • stakeholdersApprovalText
    Type: stringnullable
    read-only
    required
  • aeConfidenceLevel
    Type: DealConfidenceLevelenumnullable

    AE Confidence - Account Executive's confidence level in closing this deal

    values
    1234
  • aiAssignedProbability
    Type: number
    min:  
    0
    max:  
    100    nullable

    AI Probability - Machine learning calculated probability of deal success (0-100%)

  • amountBreakdownByPeriod
    nullable

    Payment Schedule - Breakdown of payments by time period (monthly, quarterly, annually)

    Payment Schedule - Breakdown of payments by time period (monthly, quarterly, annually)

    • propertyName
      additionalPropertyType: anything
  • annualContractValue
    Type: numbernullable

    Annual Contract Value (ACV) - Normalized annual value of the contract

  • arr
    Type: numbernullable

    Annual Recurring Revenue - Expected annual recurring revenue from this deal

  • arrLocal
    Type: numbernullable

    Annual Recurring Revenue (Local) - ARR in account's system currency

  • automaticallyAddedPartnerContacts
    Type: array of stringnullable

    Automatically added partner contact IDs

  • automaticallyAddedPeople
    Type: array of stringnullable

    Automatically added people IDs

  • autoRenewal
    Type: booleannullable

    Auto-renewal - Whether the contract automatically renews

  • closedAt
    Type: stringFormat: date-timenullable

    Actual Close Date - Date when the deal was actually closed (for closed deals only)

  • closedLostReason
    Type: integernullable

    Loss Reason ID - Identifier for the reason why the deal was lost (required if status is closed_lost)

  • closedLostReasonText
    Type: stringnullable

    Loss Reason Details - Additional details about why the deal was lost

  • companyId
    Type: stringnullable

    Company - Unique identifier of the company this deal is associated with

  • contactId
    Type: stringnullable

    Primary Contact - Main point of contact person for this deal

  • contractEndDate
    Type: stringFormat: date-timenullable

    Contract End - When the contract expires

  • contractId
    Type: stringnullable

    Contract ID - Unique identifier for the contract associated with this deal

  • contractStartDate
    Type: stringFormat: date-timenullable

    Contract Start - When the contract becomes effective

  • contractTotalAmount
    Type: numbernullable

    Total Contract Value - Complete value of the contract over its entire term

  • createdAt
    Type: stringFormat: date-timenullable

    Created at date

  • currency
    Type: stringnullable

    Currency - ISO 4217 currency code for all monetary amounts

  • dealValueAmount
    Type: numbernullable

    Deal Value - Total monetary value of the deal in the specified currency

  • expectedCloseAt
    Type: stringFormat: date-timenullable

    Expected Close Date - Anticipated date when the deal will be closed

  • implementationCost
    Type: numbernullable

    Implementation Cost - One-time cost for implementing the solution

  • lastModifiedBy
    Type: stringnullable
  • leadId
    Type: stringnullable

    Source Lead - Original lead that generated this deal (if applicable)

  • licenseId
    Type: stringnullable

    License ID - Identifier for the specific license or product variant

  • licensesInDeal
    Type: integernullable

    License Count - Number of licenses included in this deal

  • managedBy
    Type: stringnullable

    Account Executive - User ID of the sales representative managing this deal

  • manuallyAddedPartnerContacts
    Type: array of stringnullable

    Additional Partner Contacts - List of partner contact IDs manually added to this deal

  • manuallyAddedPeople
    Type: array of stringnullable

    Additional Contacts - List of person IDs manually added to this deal

  • movedToStageAt
    Type: stringFormat: date-timenullable

    Stage Change Date - When the deal was moved to the current stage

  • mrr
    Type: numbernullable

    Monthly Recurring Revenue - Expected monthly recurring revenue from this deal

  • mrrLocal
    Type: numbernullable

    Monthly Recurring Revenue (Local) - MRR in account's system currency

  • optOutDate
    Type: stringFormat: date-timenullable

    Opt-out Date - Last date customer can cancel without penalty

  • partnerContactId
    Type: stringnullable

    Partner Contact - ID of the partner contact person associated with this deal

  • partnerId
    Type: stringnullable

    Partner - ID of the partner associated with this deal (channel/referral partner)

  • potentialLicensesInCompany
    Type: integernullable

    Expansion Potential - Total potential licenses the company could purchase

  • probability
    Type: numbernullable

    Win Probability - Estimated probability of closing this deal successfully (0-100%)

  • productId
    Type: stringnullable

    Product ID - Identifier for the product being sold

  • qualificationScore
    Type: numbernullable

    Qualification Score - Numerical score indicating how well qualified this deal is (0-100)

  • stage
    Type: integernullable

    Pipeline Stage - Current stage in the sales pipeline (1=Prospect, 2=Qualification, 3=Proposal, 4=Negotiation, 5=Closed)

  • status
    Type: DealStatusenumnullable

    Deal Status - Current status: active (in progress), closed_won (successfully closed), closed_lost (lost)

    values
    1245
  • techEvaluationStatus
    Type: DealTechEvaluationStatusenumnullable

    Technical Evaluation - Status of technical evaluation process

    values
    123
  • totalContractValue
    Type: numbernullable

    Total Contract Value (TCV) - Complete value including all years and add-ons

  • trainingCost
    Type: numbernullable

    Training Cost - Cost for training customer's team

  • uploadContracts
    Type: Uploadcontractsnullable

    Contract Documents - Metadata about uploaded contract documents

    Properties: 1
  • propertyName
    additionalPropertyType: anything