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. This object is available in API version 55.0 and later.

Supported Calls

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

Special Access Rules

This object is available with Subscription Management.

Fields

Field Details
Comments
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Optional user-defined comments.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Three-letter ISO 4217 currency code associated with the payment schedule item record.
LastPaymentGatewayLogId
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
Lookup
Refers To
PaymentGatewayLog
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, this record might only have been referenced (LastReferencedDate) and not viewed.
PaymentAccountId
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
Lookup
Refers To
Account
PaymentBatchRunId
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
Lookup
Refers To
PaymentBatchRun
PaymentId
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
Lookup
Refers To
Payment
PaymentMethodId
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
Lookup
Refers To
CardPaymentMethod, DigitalWallet
PaymentProcessingMessage
Type
string
Properties
Filter, Nillable, Sort
Description
Shows information about whether the payment creation process has completed.
PaymentsReceived
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The payment received from the borrower for the payment schedule item.
PaymentRunMatchingValue
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.
PaymentScheduleId
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
Lookup
Refers To
PaymentSchedule
PaymentScheduleItemNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
User-defined reference number for the payment schedule item.
PaymentSource
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 are:
  • PaymentRun
PaymentsReceived
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The payment received from the borrower for the payment schedule item.

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

ProcessedAmount
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.
RequestedAmount
Type
currency
Properties
Create, Filter, Sort, Update
Description
The initial amount of the payment schedule item upon creation.
Status
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the payment schedule item.
Possible values are:
  • Canceled: The payment schedule item can’t be picked up by payment runs for processing. When a user or process changes the item’s status to Canceled, the item’s CanceledAmount becomes RequestedAmountProcessedAmount.
  • Apply Failed: The payment run encountered an error when attempting to process the payment schedule item for payment. For more information, review the payment run’s revenue transaction error log.
  • Applied: The payment schedule item has been successfully applied.
TargetPaymentProcessingDate
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.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the usage type for the record.
Possible value is:
  • CollectionPlan

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