PartyIncome

Represents all income earned by an individual. The income could be from various sources such as salary, commissions, fees, rental properties, and so on.

Supported Calls

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

Fields

Field	Details
CalendarYear	Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Specifies the period between January and December for any given year.
ClaimId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The claim that this party income is associated with. This field is a relationship field. Relationship Name Claim Relationship Type Lookup Refers To Claim
EmployerAddress	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description The physical address of the employer.
EmployerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The person account associated with the employer record. This field is a relationship field. Relationship Name Employer Relationship Type Lookup Refers To Account
EmployerName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the employer.
EmployerPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of the employer.
EndDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the party income ends.
IncomeAmount	Type currency Properties Create, Filter, Sort, Update Description Required. The total amount of income the individual makes for a given period.
IncomeFrequency	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the frequency of the party income. Possible values are: `Monthly` `Weekly` `Yearly`
IncomeLossPercent	Type percent Properties Create, Filter, Nillable, Sort, Update Description The percentage loss of income due to a change in the individual's employment status.
IncomeStatus	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the status of the income. Possible values are: `Active` `Inactive`
IncomeType	Type picklist Properties Create, Filter, Group, Sort, Update Description Required. Specifies the type of income such as salary, commissions, rentals, and so on. Possible values are: `Commission` `Fees` `Rent` `Salary`
JobTitle	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The job title of the individual receiving the income.
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, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
ModificationReason	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The reason for a change in an individual's employment status.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Name of the party income.
NetIncome	Type currency Properties Create, Defaulted on create, Filter, Nillable, Sort, Update Description The amount made by an individual every month after deductions.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description ID of the record owner. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PartyId	Type reference Properties Create, Filter, Group, Sort, Update Description Required. The Party associated with the Party Income. This field is a polymorphic relationship field. Relationship Name Party Relationship Type Lookup Refers To Account, Contact
StartDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description The date when the party income starts.
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the usage type of the party income. Valid value is `PublicSector` for Program and Benefit Management. Available in API version 60.0 and later.

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.

PartyIncomeChangeEvent (API version 62.0): Change events are available for the object.
PartyIncomeFeed: Feed tracking is available for the object.
PartyIncomeHistory: History is available for tracked fields of the object.
PartyIncomeOwnerSharingRule: Sharing rules are available for the object.
PartyIncomeShare: Sharing is available for the object.

Public Sector Solutions Developer Guide

PartyIncome

Supported Calls

Fields

Associated Objects