PaymentScheduleTreatment | Object Reference for the Salesforce Platform

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), 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.

Fields

Field	Details
Description	Type textarea Properties Create, Filter, Nillable, Sort, Update Description The user-entered description of the payment schedule treatment.
IsApprovalRequired	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether this payment schedule treatment requires approval or not. Available in API version 65.0 and later with Financial Services and Automotive Cloud. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp when the current user last viewed this record or list view. If this value is null, the user might have only accessed this record or list view (LastReferencedDate) but not viewed it.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description The user-entered name of the payment schedule treatment.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the owner of this object. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PaymentPlanTag	Type textarea Properties Create, Filter, Nillable, Sort, Update Description A list of key annotations or insights about the payment plan, such as requires approval or recommended, to help guide the user in selecting the most suitable payment plan. Available in API version 65.0 and later with Financial Services and Automotive Cloud.
PaymentSchedulePolicyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the related payment schedule policy. This field is a relationship field. Relationship Name PaymentSchedulePolicy Relationship Type Lookup Refers To PaymentSchedulePolicy
Status	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description The payment schedule treatment’s status. Possible values are: `Active` `Canceled` `Draft` `Inactive`
TriggerSource	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Indicates the action that caused the payment schedule treatment to be created. Possible values are: `InvoicePosted`—an invoice is posted `UserAction`—User Action Available in API version 65.0 and later with Financial Services and Automotive Cloud.