Public Sector Solutions Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Public Sector Solutions Data Models
Public Sector Solutions Standard Objects
Accreditation
ActionPlan
ActionPlanBaseTemplateAsgn
ActionPlanItem
ActionPlanTemplate
ActionPlanTemplateItem
ActionPlanTemplateItemValue
ActionPlanTemplateVersion
ActionPlanTemplateAssignment
ActionPlanTmplItmAssessmentInd
ApplicationForm
ApplicationFormEvaluation
ApplicationFormEvalPtcp
ApplicationFormParticipant
ApplicationFormRelation
ApplicationDecision
ApplicationRenderMethod
ApplicationReview
ApplicationStageDefinition
ApplicationTimeline
AssessmentIndicatorDefinition
AssessmentIndDefinedValue
AssessmentIndValue
AssessmentTask
AssessmentTaskDefinition
AssessmentTaskContentDocument
AssessmentTaskIndDefinition
AuthApplicationAsset
AuthApplicationPlace
AuthLocationAccessSchedule
Award
Benefit
BenefitAssignment
BenefitAssignmentAdjustment
BenefitDisbursement
BenefitDisbursementAdj
BenefitItemCode
BenefitPrvdSearchableFld
BenefitSchedule
BenefitScheduleAssignment
BenefitSession
BenefitSpecialty
BenefitType
BoardCertification
Budget
BudgetAllocation
BudgetCategory
BudgetCategoryValue
BudgetParticipant
BudgetPeriod
BusinessLicense
BusinessLicenseApplication
BusinessMilestone
BusinessProfile
BusinessType
BusRegAuthorizationType
BusRegAuthTypeDependency
CareBarrier
CareBarrierType
CarePlan
CarePlanDetail
CarePlanTemplate
CarePlanTemplateBenefit
CarePlanTemplateGoal
CareProviderAdverseAction
CareProviderFacilitySpecialty
CareSpecialty
CaseEpisode
CaseParticipant
CaseProceeding
CaseProceedingComplaint
CaseProceedingInfraction
CaseProceedingParticipant
CaseProceedingResult
CaseProgram
Claim
ClaimItem
ClaimParticipant
CodeSet
CodeSetBundle
ComplaintCase
ComplaintParticipant
Contact
ContactProfile
CourseOffering
CustodyChainEntry
CustodyItem
CustodyItemRelation
CustodyItemRgltyCodeVio
DocumentChecklistItem
Employee2
Employment
EmploymentOffer
EmploymentOfferVettingEval
Examination
FundingAward
FundingAwardAmendment
FundingAwardParticipant
FundingAwardRequirement
FundingAwardRqmtSection
FundingDisbursement
FundingOpportunity
FundingOppParticipant
GenericVisitTask
GenericVisitTaskContext
GoalAssignment
GoalAssignmentDetail
GoalDefinition
GnrcVstKeyPerformanceInd
GnrcVstTaskContextRelation
HealthcareFacility
HealthcarePractitionerFacility
HealthcareProvider
HealthcareProviderNpi
HealthcareProviderSpecialty
IndividualApplication
IndividualApplicationTask
IndividualApplnParticipant
InspectionAssessmentInd
InspectionType
InsurancePolicy
InsurancePolicyTransaction
IntakeFormSection
Interaction
InteractionAttendee
InteractionRelatedAccount
InteractionSumDiscussedAccount
InteractionSummary
JobApplnSearchableField
JobPosition
JobPositionPayGrade
JobPostingSearchableField
JobPstnRecruitmentRqs
Location
Occupation
OccupationGroup
OmniAssessmentTask
OmniDataPack
OmniDataTransform
OmniDataTransformItem
OmniESignature
OmniProcess
OmniProcessCompilation
OmniProcessElement
OmniProcessOmniAsmtTask
OmniProcessTransientData
OmniScriptSavedSession
OmniUiCard
OperatingHours
OperatingHoursHoliday
PartyCertifiedCapacity
PartyExpense
PartyFinancialAsset
PartyIncome
PartyProfile
PartyProfileAddress
PayGrade
PayGradeStep
PayGradeStepLocation
PaymentRequest
PaymentRequestLine
PersonDisability
PersonEducation
PersonEmployment
PersonExamination
PersonLifeEvent
Polygon
Position
PositionPayGrade
PreliminaryApplicationRef
Program
ProgramCohortMember
ProgramEnrollment
PublicApplicationParticipant
PublicComplaint
RecruitmentContentSection
RecruitmentPosting
RecruitmentPostingCntntSect
RecruitmentRequisition
RecruitmentRequisitionLoc
RecruitmentRequisitionPtcp
RecurrenceSchedule
ReceivedDocument
ReceivedDocumentType
Referral
RegulatoryAuthority
RegulatoryAuthorizationType
RegulatoryCode
RegulatoryCodeUse
RegCodeAssessmentInd
RegulatoryCodeViolation
RegulatoryTrxnFee
RegulatoryTrxnFeeItem
RegAuthorizationTypeProduct
SignatureTask
SignatureTaskLineItem
TagCategory
TimeSlot
TrainingCourseParticipant
TrnCourse
VettingEvaluation
ViolationEnforcementAction
ViolationType
ViolationTypeUse
ViolationTypeAssessmentInd
Visit
Visitor
VisitedParty
VolunteerProject
WorkerCompCoverageClass
PublicSectrSltn Namespace
Public Sector Solutions APIs
Public Sector Solutions Standard Invocable Actions
Public Sector Solutions Tooling API Objects
Public Sector Solutions Metadata API Types
Public Sector Solutions Associated Objects
StandardValueSet Names and Standard Picklist Fields
Accounting Subledger
Action Launcher
Business Rules Engine
Criteria-Based Search and Filter
Decision Explainer
Discovery Framework
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Record Alerts
Record Rollup Definitions
Service Process Studio
Timeline
PDF

BenefitSchedule

Represents information about the plan for delivering the benefit. This object is available in API version 58.0 and later.

Supported Calls

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

Fields

Field Details
ApprovalStatus
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the approval status of the benefit schedule. Available in API version 61.0 and later.
Possible values are:
  • Approved
  • In Review
  • Not Applicable
  • Pending
  • Rejected
BenefitId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The identifier of the benefit that's associated with the schedule.
This field is a relationship field.
Relationship Name
Benefit
Relationship Type
Lookup
Refers To
Benefit
DefaultBenefitQuantity
Type
double
Properties
Create, Filter, Sort, Update
Description
The default quantity of benefit that's provided within a session of benefit schedule.
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
The description of the benefit schedule.
FirstSessionEndDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the first session ends in the benefit schedule.
FirstSessionStartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The date and time when the first session begins in the benefit schedule.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.
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, and LastReferenceDate is not null, the user accessed this record or list view indirectly.
MaximumParticipantCount
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of participants in a session.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the benefit schedule.
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
PractitionerFacilityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The practitioner facility associated with the benefit session record.
Available in API version 59.0 and later.
This field is a relationship field.
Relationship Name
PractitionerFacility
Relationship Type
Lookup
Refers To
HealthcarePractitionerFacility

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

BenefitScheduleFeed
Feed tracking is available for the object.
BenefitScheduleHistory
History is available for tracked fields of the object.