PaymentScheduleItem

A payment schedule contains one or more payment schedule items, where each item represents one payment to be processed. Each of a schedule’s items can have different payment configuration fields, such as payment methods, payment dates, and payment accounts. When a payment scheduler launches a payment run, the run evaluates active payment schedule items, and picks them up for payment processing if they align with the scheduler’s payment criteria.

Introduced in API version 55.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

  • This object is available with Subscription Management and Billing (Revenue Cloud).
  • For information about this object that’s available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 62.0
  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Optional user-defined comments.
  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 66.0

  • Default value: false

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    The most recent payment gateway log created following a payment gateway request to make a payment based on the payment schedule item.

    This is a relationship field.

  • Relationship name: LastPaymentGatewayLog

  • Relationship type: relationship

  • Refers to: PaymentGatewayLog

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 66.0
  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort
  • Introduced: API version 66.0
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The account assigned to payments made from the payment schedule item. When a payment schedule item is created, its PaymentAccountId inherits the payment schedule’s DefaultPaymentAccountId. However, you can provide a new PaymentAccountId at any time. If you change the PaymentAccountId, only payments made after the change use the new account.

    This is a relationship field.

  • Relationship name: PaymentAccount

  • Relationship type: relationship

  • Refers to: Account

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Description:

    The payment batch run that evaluated the payment schedule item for payment processing.

    This is a relationship field.

  • Relationship name: PaymentBatchRun

  • Relationship type: relationship

  • Refers to: PaymentBatchRun

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 66.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 66.0
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 64.0
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    The payment that a payment run created for the payment schedule item after picking up the parent payment schedule. This field is unique within your organization

    This is a relationship field.

  • Relationship name: Payment

  • Relationship type: relationship

  • Refers to: Payment

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Relationship name: PaymentInitiationSource

  • Relationship type: relationship

  • Refers to: PaymentInitiationSource

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The payment method assigned to payments created from the payment schedule item. When a payment schedule item is created, its PaymentMethodId inherits the payment schedule’s DefaultPaymentMethodId. However, you can provide a new PaymentMethodId at any time. If you change the PaymentMethodId, only payments made after the change use the new account.
  • Relationship name: PaymentMethod
  • Relationship type: polymorphic
  • Refers to: CardPaymentMethod, SavedPaymentMethod
  • Type: string
  • Properties: Filter, Nillable, Sort
  • Description: Shows information about whether the payment creation process has completed.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort
  • Introduced: API version 66.0
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The value used to match a payment schedule item to a payment run based on the payment run’s matching criteria.
  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The parent payment schedule for the payment schedule item.

    This is a relationship field.

  • Relationship name: PaymentSchedule

  • Relationship type: masterdetail

  • Refers to: PaymentSchedule

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: User-defined reference number for the payment schedule item.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Description: The feature that caused a payment to be created from the payment schedule item.
  • Possible values:
    • PaymentRun — PaymentRun
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The payment received from the borrower for the payment schedule item. with Financial Services and Automotive Cloud.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The amount of the payment schedule item that has been processed for payment and converted to a payment record.
  • Type: currency
  • Properties: Create, Filter, Sort, Update
  • Description: The initial amount of the payment schedule item upon creation.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: The status of the payment schedule item.
  • Possible values:
    • Applied — Applied
    • Apply Failed — Apply Failed
    • Approval Pending — Approval Pending
    • Canceled — Canceled — ProcessedAmount.
    • Deferred Payment — Deferred Payment
    • Payment Waived Off — Payment Waived Off
  • Type: date
  • Properties: Create, Filter, Group, Sort, Update
  • Description: The date after picking up a payment schedule item that the payment run makes a payment request to the payment gateway.
  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 62.0

  • Description:

    Specifies the usage type for the record.

    Possible value is:

    Available in API version 62.0 and later with Financial Services and Automotive Cloud.

  • Possible values:

    • CollectionPlan — CollectionPlan