DuplicateRevenueItemInput

A single service line in the duplication payload.

Same shape as RevenueItemInput (the create-service body), with two differences: contract_id is optional and ignored — the server assigns the new contract's id — and custom_field_values carries the revenue-item-level custom column values (rifd- fields) so they survive the re-create. Without that map, custom values would be silently dropped even on unmodified lines, because the duplicate re-creates each item from the payload rather than copying the source row server-side. Service dates arrive final from the client (any shift-dates edits already applied); the server persists them as-is.

  • autoRenewal
    Type: boolean

    Auto renewal flag

  • billingEndDate
    Type: stringFormat: date-timenullable

    Billing end date

  • billingStartDate
    Type: stringFormat: date-timenullable

    Billing start date

  • contractId
    Type: stringnullable

    Ignored on duplicate — the server assigns the new contract's id

  • customBillingFrequency
    Type: integernullable

    Custom billing frequency

  • customDuration
    Type: integernullable

    Custom duration

  • customFieldValues
    Type: Customfieldvaluesnullable

    Revenue-item custom field values, keyed by field id (rifd-...)

    Properties: 1
  • customOptOutDate
    Type: stringFormat: date-timenullable

    Custom opt out date

  • customServiceDuration
    Type: integernullable

    Custom service duration

  • dealId
    Type: stringnullable

    Deal ID — auto-populated from the parent contract on create; any client-supplied value is ignored

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

  • pricePerUnit
    Type: numbernullable

    Price per unit in the contract's local currency — negative on a discount or credit line

  • quantity
    Type: numbernullable

    Quantity — fractional allowed, negative for a downsell

  • scheduledPayments
    Type: array of RevenueItemsScheduledPaymentInputnullable

    Scheduled payments for this revenue item

    Properties: 4
  • 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

  • total
    Type: numbernullable

    Total amount — negative on a downsell line

  • totalLocal
    Type: numbernullable

    Total amount in local currency — negative on a downsell line