PaymentSchedule

The payment schedule represents a collection of payments that a customer wants to collect at different times for a certain record. A 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.

This guide only lists certain information for each object. For more information, including descriptions of the fields, see PaymentSchedule in the Billing Guide and Object Reference for the Salesforce Platform.

Field Name	Field Label	Type	Digits	Length	Precision	Scale
AvailableRequestedAmount	Available Requested Amount	currency			18	2
Comments	Comments	textarea		1000
CreatedById	Created By ID	reference		18
CreatedDate	Created Date	datetime
DefaultPaymentAccountId	Default Payment Account ID	reference		18
DefaultPaymentMethodId	Default Payment Method ID	reference		18
Id	Payment Schedule ID	id		18
IsDeleted	Deleted	boolean
LastModifiedById	Last Modified By ID	reference		18
LastModifiedDate	Last Modified Date	datetime
LastReferencedDate	Last Referenced Date	datetime
LastViewedDate	Last Viewed Date	datetime
OwnerId	Owner ID	reference		18
PaymentScheduleNumber	Payment Schedule Number	string		255
PaymentScheduleTreatmentDtlId	Payment Schedule Treatment Detail ID	reference		18
PaymentSource	Payment Source	picklist		40
ReferenceEntityId	Reference Entity ID	reference		18
RemainingAmountToBeProcessed	Remaining Amount To Be Processed	currency			18	2
Status	Status	picklist		255
SystemModstamp	System Modstamp	datetime
TotalAppliedAmount	Total Applied Amount	currency			18	2
TotalCanceledAmount	Total Canceled Amount	currency			18	2
TotalPaymentScheduleItemAmount	Total Payment Schedule Item Amount	currency			18	2
TotalPaymentsReceived	Total Payments Received	currency			18	2
TotalProcessedAmount	Total Processed Amount	currency			18	2
TotalRequestedAmount	Total Requested Amount	currency			18	2
Type	Type	picklist		255
UsageType	Usage Type	picklist		255

Sharing for PaymentSchedule.

This guide only lists certain information for each object. For more information, including descriptions of the fields, see StandardObjectNameShare in the Object Reference for the Salesforce Platform.

Field Name	Field Label	Type	Digits	Length	Precision	Scale
AccessLevel	Custom Object Access	picklist		40
Id	Custom Object Share ID	id		18
IsDeleted	Deleted	boolean
LastModifiedById	Last Modified By ID	reference		18
LastModifiedDate	Last Modified Date	datetime
ParentId	Parent ID	reference		18
RowCause	Row Cause	picklist		40
UserOrGroupId	User/Group ID	reference		18