--- schema_version: "1" id: b80af6d402bdbc1836af0328395e065bd1e6e1bd68b1a6cd288824a9db88b3ae title: PaymentSchedule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_paymentschedule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_paymentschedule.htm source_site: developer.salesforce.com content_type: documentation content_hash: 7c5d4207d84b2180d433f25643f0360fa7725bb5419013b3f927776ea2233cac description: 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. --- # 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. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules 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](https://developer.salesforce.com/docs/atlas.en-us.264.0.revenue_lifecycle_management_dev_guide.meta/revenue_lifecycle_management_dev_guide/sforce_api_objects_paymentschedule.htm "HTML (New Window)"). ## Fields | Field | Details | | --- | --- | | AvailableRequestedAmount | Type currency Properties Filter, Nillable, Sort Description The payment schedule’s remaining amount available for the creation of payment schedule items. Equals TotalRequestedAmount–TotalLineRequestedAmount. | | 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 group record. | | DefaultPaymentAccountId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When a payment run creates payments from a payment schedule item, it sets the payment’s account to the item’s PaymentAccountId. Upon payment schedule item creation, the item’s PaymentAccountId inherits the schedule’s DefaultPaymentAccountId. However, you can override the PaymentAccountId with a different account as needed. If you do, future payments made from the item use the new account. This is a relationship field. Relationship Name DefaultPaymentAccount Relationship Type Lookup Refers To Account | | DefaultPaymentMethodId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description When a payment run creates payments from a payment schedule ID, it sets the payment’s account to the item’s PaymentMethodId. Upon payment schedule item creation, the item’s PaymentMethoId inherits the schedule’s DefaultPaymentMethodId. However, you can override the PaymentMethodId with a different account as needed. If you do, future payments made from the item will use the new account. Relationship Name DefaultPaymentMethod Relationship Type Lookup Refers To CardPaymentMethod, DigitalWallet | | 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. | | OwnerId | Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The user who created the payment schedule. This is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User | | PaymentScheduleNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description System-generated reference number for the payment schedule. | | PaymentScheduleTreatmentDtlId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The payment schedule treatment detail associated with the payment schedule record. This field is a relationship field. Available in API version 65.0 and later with Financial Services and Automotive Cloud. Relationship Name PaymentScheduleTreatmentDtl Refers To PaymentScheduleTreatmentDtl | | PaymentSource | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the name of the funding source that is used to fulfill a payment commitment. Available in API version 63.0 and later with Financial Services and Automotive Cloud. | | ReferenceEntityId | Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The object that receives payments as a result of payment schedule items processed from the payment schedule. This is a polymorphic relationship field. Relationship Name ReferenceEntity Relationship Type Lookup Refers To API version 55.0 and later: - Contract - Order - Invoice API version 62.0 and later with Financial Services and Automotive Cloud: CollectionPlan | | RemainingAmountToBeProcessed | Type currency Properties Filter, Nillable, Sort Description The total pending amount of payment schedule items that haven’t yet been processed for payment. Equals TotalLineRequestedAmount – TotalProcessedAmount. | | Status | Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The status of the payment schedule. Possible values are: - Accepted: The payment schedule is approved and is ready for payment run evaluation. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Approval Pending: The payment schedule needs approval. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Canceled: Payment runs can’t evaluate payment schedules or use them to create payments. - Completed: All of the payment schedule’s payment schedule items have been processed for payments. - Draft: The payment schedule can be edited and configured. Payment runs don’t evaluate draft payment schedules. - On Hold: The payment schedule can't be considered for payment runs due to missing information, the need for additional review, or other unresolved external factors. Available in API version 65.0 and later with Financial Services and Automotive Cloud. - Open: The payment schedule is available for payment run evaluation. - Rejected: The payment schedule isn't approved and can't be considered for payment run evaluation. Available in API version 65.0 and later with Financial Services and Automotive Cloud. | | TotalAppliedAmount | Type currency Properties Filter, Nillable, Sort Description The amount of all payment schedule items that have been applied to payments. This is a calculated field. | | TotalCanceledAmount | Type currency Properties Filter, Nillable, Sort Description The sum of all RequestedAmount values on payment schedule items with a status of Canceled. | | TotalPaymentsReceived | Type currency Properties Filter, Nillable, Sort Description The cumulative sum of payments received for all payment schedule items linked to a payment schedule. This field is a calculated field. Available in API version 63.0 and later with Financial Services and Automotive Cloud. | | TotalPaymentScheduleItemAmount | Type currency Properties Filter, Nillable, Sort\\ Description The total amount allocated from the payment schedule to its payment schedule items. Equals the sum of each payment schedule item’s RequestedAmount – the sum of each payment schedule item’s Canceled Amount. | | TotalProcessedAmount | Type currency Properties Filter, Nillable, Sort Description The sum of ProcessedAmount values on payment schedule items with a status of Processed. | | TotalRequestedAmount | Type currency Properties Create, Filter, Sort, Update Description The total amount available for a payment schedule to distribute to its payment schedule items. The sum of payment schedule items can’t be greater than the TotalLineRequestedAmount of the parent payment schedule. | | Type | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The type of payment for which the payment schedule is created. Available in API version 65.0 and later with Financial Services and Automotive Cloud. Possible values are: - PaymentPlan—Payment Plan - PromiseToPay—Promise to Pay | | 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. |