ExtendedBaseModel

  • aeOwner
    Type: stringnullable
    read-only
    required
  • autoRenewalDisplay
    Type: string
    read-only
    required
  • billingFrequencyDisplay
    Type: string
    read-only
    required
  • companyName
    Type: stringnullable
    read-only
    required
  • contractId
    Type: string
    required

    Contract ID

  • contractName
    Type: stringnullable
    read-only
    required
  • csmOwner
    Type: stringnullable
    read-only
    required
  • currency
    Type: stringnullable
    read-only
    required
  • customServiceDurationDisplay
    Type: string
    read-only
    required
  • durationDisplay
    Type: string
    read-only
    required
  • id
    Type: string
    min length:  
    1
    required

    revenue_item ID

  • nextBillingDate
    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

  • pricing
    Type: numbernullable
    read-only
    required
  • productName
    Type: stringnullable
    read-only
    required
  • statusName
    Type: stringnullable
    read-only
    required
  • autoRenewal
    Type: booleannullable

    Auto renewal flag

  • billingEndDate
    Type: stringFormat: date-timenullable

    Billing end date

  • billingStartDate
    Type: stringFormat: date-timenullable

    Billing start date

  • chargeType
    Type: integernullable

    Charge type ID (FK to charge_types, 1=recurring 2=one-time)

  • createdAt
    Type: stringFormat: date-timenullable

    Created at date

  • customBillingFrequency
    Type: integernullable

    Custom billing frequency

  • customDuration
    Type: integernullable

    Custom duration

  • customOptOutDate
    Type: stringFormat: date-timenullable

    Custom opt out date

  • customServiceDuration
    Type: integernullable

    Custom service duration

  • dealId
    Type: stringnullable

    Deal ID inherited from the parent contract

  • discountAmount
    Type: numbernullable

    Discount amount

  • eqPaymentsBillingFrequency
    Type: integernullable

    Equal payments billing frequency

  • eqPaymentsNumOfPayments
    Type: integernullable

    Equal payments number of payments

  • isDiscountPercentage
    Type: booleannullable

    Is discount percentage flag

  • itemOrder
    Type: integernullable

    Display order index (0-based)

  • periodIndex
    Type: integernullable

    Ordinal of an elapsed auto-renewal period, 1 being the oldest. Null on the current-period row

  • previousPeriods
    Type: array of RevenueItemOutput

    Elapsed auto-renewal periods of this service, most-recent-first, each frozen at the values in force when that period closed. Empty when the service has never renewed, when auto-renewal is switched off, and on the entries themselves — history never nests

    Properties: 45
  • pricePerUnit
    Type: numbernullable

    Price per unit in the contract's local currency

  • quantity
    Type: numbernullable

    Quantity

  • scheduledPayments
    Type: array of RevenueItemsScheduledPaymentOutput

    Scheduled payments for this revenue item

    Properties: 8
  • serviceEndDate
    Type: stringFormat: date-timenullable

    Service end date

  • serviceItemId
    Type: stringnullable

    Service item ID

  • serviceItemName
    Type: stringnullable

    Service item name

  • serviceItemPricingId
    Type: stringnullable

    Service item pricing ID

  • serviceStartDate
    Type: stringFormat: date-timenullable

    Service start date

  • serviceType
    Type: integernullable

    Service item type ID (FK to service_item_types)

  • status
    Type: integernullable

    Revenue item status ID (FK to revenue_item_statuses, e.g. DRAFT=5, ACTIVE=1)

  • total
    Type: numbernullable

    Total amount

  • totalLocal
    Type: numbernullable

    Total amount in local currency

  • propertyName
    additionalPropertyType: anything