Update Income Source

patch

https://{your-totality-url}.com/api/income-sources/{incomeSourceUuid}

Partially update an existing income source. Only the fields present in the request body are changed; all other fields are left unchanged and no new income source record is created. Permission: Update Income Sources

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

incomeSourceUuid

string

required

The UUID of the income source to update.

Body Params

afterNextPaidOn

string

The date of the paycheck after the next one, in YYYY-MM-DD format. Used for payment scheduling.

employerName

string

The name of the customer's employer.

employmentBasis

string

The employment basis (e.g., Full-Time, Part-Time, Contract, Self-Employed). One of: Full-Time, Part-Time.

isPrimary

boolean

Whether this is the customer's primary income source. Setting this to true demotes the customer's other income sources.

jobTitle

string

The customer's job title at this employer.

lastPaidOn

string

The date the customer was most recently paid, in YYYY-MM-DD format.

lastPaycheck

integer

The dollar amount of the customer's most recent paycheck.

monthlyIncome

integer

The customer's gross monthly income in dollars from this source.

monthsEmployed

integer

The number of months the customer has been employed at this employer.

nextPaymentDate

string

The date the customer will next be paid, in YYYY-MM-DD format. Used for payment scheduling.

paymentFrequency

string

How often the customer is paid (e.g., weekly, bi-weekly, semi-monthly, monthly). One of: days, weekly, bi-weekly, semi-monthly, monthly. Title-cased values such as "Bi-Weekly" are also accepted.

paymentType

string

The method by which the customer receives pay (e.g., Direct Deposit, Check). One of: Cash, Check, Credit Card, Debit Card, Direct Deposit.

salaryBasis

string

The basis on which the salary is calculated (e.g., Hourly, Salary, Commission). One of: Hourly, Salaried.

secondLastPaidOn

string

The date of the customer's second most recent payday, in YYYY-MM-DD format.

secondLastPaycheck

integer

The dollar amount of the customer's second most recent paycheck.

source

string

The type of income source (e.g., Employment, Self-Employment, Social Security, Disability, Pension). One of: Disability, Employment, Other, Pension, Retirement, Self-Employed, Self-Employment, Social Security, Unemployment, Welfare.

thirdLastPaidOn

string

The date of the customer's third most recent payday, in YYYY-MM-DD format.

thirdLastPaycheck

integer

The dollar amount of the customer's third most recent paycheck.

workPhone

string

The customer's work phone number.

workShift

string | null

The customer's work shift (e.g., Day, Night, Rotating). One of: Day, Afternoon, Night, Rotating, Split.

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200The updated income source.

401401

403403

404404

422Validation failed, or a business rule was violated - for example a prohibited employer or job title, or a missing payment frequency for a source other than Unemployment.

500500