---
schema_version: "1"
id: 620be502310913f5aed99546126443046db2b3c3eb6a9371e99a1814baf59806
title: PartyIncome
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/sforce_api_objects_partyincome.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_partyincome.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 3374842823827b59045f6ebe14f0007a19e52d55a9e0c80fcd8ae6b34f2d7916
description: Represents the income of an individual or a business entity. This income can be from salaries, commissions, fees, rental properties, and other sources. This object is available in API version 55.0 and later.
---
# PartyIncome

Represents the income of an individual or a business entity. This income can be from salaries, commissions, fees, rental properties, and other sources. This object is available in API version 55.0 and later.

## Supported Calls

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

## Fields

### ApplicationFormId

- **Type**: reference
- **Properties**: Filter, Group, Nillable, Sort
- **Description**: The application form that's submitted for a party income. Available with Digital Lending.
    
    This field is a relationship field.
- **Relationship Name**: ApplicationForm
- **Relationship Type**: Lookup
- **Refers To**: ApplicationForm

### CalendarYear

- **Type**: int
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: The calendar year when the income was earned.

### ClaimId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The claim associated with the party income.
    
    This field is a relationship field.
- **Relationship Name**: Claim
- **Relationship Type**: Lookup
- **Refers To**: Claim

### CurrencyIsoCode

- **Type**: picklist
- **Properties**: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: If multiple currencies are enabled, this field contains the currency ISO code associated with the record.
- **Default value**: USD
- **Possible values**:
    - AED—UAE Dirham
    - CAD—Canadian Dollar
    - GBP—British Pound
    - JPY—Japanese Yen
    - USD—U.S. Dollar

### EmployerAddress

- **Type**: textarea
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The compound form of the employer's address.

### EmployerId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The employer associated with the party income.
    
    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, Sort, Update
- **Description**: The date when the party income ends.

### IncomeAmount

- **Type**: currency
- **Properties**: Create, Filter, Sort, Update
- **Description**: The amount of the party income.

### IncomeAsOfDate

- **Type**: date
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The date when the party income is documented. Available with Digital Lending.

### IncomeFrequency

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- **Description**: The frequency of the party income.
- **Possible values**:
    - Monthly
    - One Time
    - Weekly
    - Yearly

### IncomeSourceId

- **Type**: reference
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The source of the income. Available with Digital Lending.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: IncomeSource
- **Relationship Type**: Lookup
- **Refers To**: PartyFinancialAsset, PersonEmployment

### IncomeStatus

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: The status of the party income.
- **Possible values**:
    - Active
    - Inactive

### IncomeType

- **Type**: picklist
- **Properties**: Create, Filter, Group, Restricted picklist, Sort, Update
- **Description**: The type of the income.
- **Possible values**:
    - Salary
    - Commission—
    - Fees—
    - Rent—
    - Bonus
    - Dividend
    - Interest Income

### IsReadOnly

- **Type**: boolean
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: Indicates whether the party income is read only (true) or not (false).
- **Default value**: false

### JobTitle

- **Type**: string
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The job title of the party.

### 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.

### Name

- **Type**: string
- **Properties**: Autonumber, Defaulted on create, Filter, idLookup, Sort
- **Description**: The name of the party income.

### OwnerId

- **Type**: reference
- **Properties**: Create, Defaulted on create, Filter, Group, Sort, Update
- **Description**: The owner associated with the party income.
    
    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**: The party associated with the party income.
    
    This field is a polymorphic relationship field.
- **Relationship Name**: Party
- **Relationship Type**: Lookup
- **Refers To**: Account, Applicant, ClaimParticipant, Contact, PartyProfile

### PartyProfileId

- **Type**: reference
- **Properties**: Filter, Group, Nillable, Sort
- **Description**: The party profile associated with an applicant. Available with Digital Lending
    
    This field is a relationship field.
- **Relationship Name**: PartyProfile
- **Relationship Type**: Lookup
- **Refers To**: PartyProfile

### StartDate

- **Type**: dateTime
- **Properties**: Create, Filter, Sort, Update
- **Description**: The date when the party income starts.

### UsageType

- **Type**: picklist
- **Properties**: Filter, Group, Nillable, Restricted picklist, Sort
- **Description**: Internal field. Specifies the application using the party income to populate data.
- **Possible values**:
    - CashFlow—Cash Flow
    - Claim
    - KnowYourCustomer—Know Your Customer
    - VehicleAndAssetLoanOrigination—Vehicle And Asset Loan Origination
    - Know Your Customer

### VerificationDate

- **Type**: date
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The timestamp when the verification status is updated.

### VerificationStatus

- **Type**: picklist
- **Properties**: Create, Filter, Group, Nillable, Sort, Update
- **Description**: The verification status of the party income.