RecurrenceSchedule

Represents the recurrence schedule for a benefit schedule. This object is available with Program Management in API version 57.0 and later.

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

• Type: int
• Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
• Description: The number of times the schedule was completed.

• Type: date
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The date when the schedule ends.

• Type: string
• Properties: Create, Filter, Group, idLookup, Sort, Update
• Description: The name of the recurrence schedule.

• Type: dateTime
• Properties: Create, Filter, Sort, Update
• Description: The date and time when the schedule is executed next.

• Type: reference

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

• Description: The user who owns the object.

  This field is a polymorphic relationship field.

• Relationship Name: Owner

• Relationship Type: Lookup

• Refers To: Group, User

• Type: picklist

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

• Description: The name of the scheduling process that executes the request.

• Possible values:

  • Industries_ActionPlan
  • Industries_ProgramManagement

• Type: reference

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

• Description: The related record for which you’re creating the recurrence schedule. For example, creating a recurrence schedule for a related Benefit Schedule entity.

  This field is a polymorphic relationship field.

• Relationship Name: ReferenceRecord

• Relationship Type: Lookup

• Refers To: ActionPlan, BenefitSchedule

• Type: int

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

• Description: The days in a week when the schedule is executed. This field contains a bit mask.

  • Monday = 64
  • Tuesday = 32
  • Wednesday = 16
  • Thursday = 8
  • Friday = 4
  • Saturday = 2
  • Sunday = 1 Multiple days are represented as the sum of their numerical values. For example, Tuesday and Thursday = 32 + 8 = 40.

• Type: picklist

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

• Description: Specifies the frequency at which the schedule is executed.

• Possible values:

  • Biweekly
  • Halyearly—Half Yearly
  • Monthly
  • Quarterly
  • Weekly
  • Yearly

• Type: dateTime
• Properties: Create, Filter, Sort, Update
• Description: The date when the schedule begins.

• Type: picklist

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

• Description: The status of the schedule.

• Possible values:

  • Active
  • Inactive

• Type: int
• Properties: Create, Filter, Group, Nillable, Sort, Update
• Description: The number of times the schedule is executed.

j

Introduction to Nonprofit Cloud

Nonprofit Cloud Data Model

Fundraising

Program Management

Program Management Standard Objects

Benefit

BenefitAssignment

BenefitDisbursement

BenefitSchedule

BenefitScheduleAssignment

BenefitSession

BenefitType

CaseProgram

Program

ProgramCohort

ProgramCohortMember

ProgramEnrollment

RecurrenceSchedule

Program Management Business APIs

Case Management

Outcome Management Standard Objects

Grantmaking

Volunteer Management Standard Objects

Volunteer Management Fields on Other Objects

Group Memberships and Households in Nonprofit Cloud

Record Rollup Definitions

NonProfit Cloud Associated Objects

Previous Versions