Skip to navigation
API ReferenceIncomes

List Incomes

List income lines reported on applicants' affordable income checklists. Filter by customerId, applicationId or certificationId to read one person's or one certification's incomes.

Authentication

x-api-keystring
API Key authentication via header

Response

A paged array of incomes
customerIdstringformat: "uuid"
typeenumOptional

The kind of income. RECENTLY_ENDED_JOB is the applicant’s previous job; it carries no amount, and is returned only when the job has an employer, address, phone, supervisor, title or date. Employment rows the applicant marked as self-employment or military pay are SELF_EMPLOYMENT and MILITARY_PAY. COURT_ORDERED_CHILD_SUPPORT is the amount a court ordered, which may differ from the CHILD_SUPPORT actually received.

payComponentenumOptional

Which part of employment pay a JOB line is: base pay, overtime, tips, bonuses or an anticipated pay increase. Empty when the checklist did not record it (legacy employment totals, rows with no pay type, and Ohio forms, which record an employment type such as Agriculture instead; Fortress treats those as base pay).

Allowed values:
startDatedateOptional

Job start date, from the job the applicant reported. Set only on lines that carry a job (see employerName for which lines do), even when that job has no employer name.

endDatedateOptional

Job end date, when the applicant reported one. In practice set on RECENTLY_ENDED_JOB lines only; empty for non-job income.

annualAmountdoubleOptional
Annual gross amount of this line in USD, as entered on the income checklist.
payRatedoubleOptional

Amount paid per pay period (per hour when payFrequency is HOURLY), in USD.

payFrequencyenumOptional
How often payRate is paid.
hoursPerWeekdoubleOptional
Hours worked per week. Only set when payFrequency is HOURLY.
employerNamestringOptional

Employer of a JOB or RECENTLY_ENDED_JOB line. The checklist does not store an employer per line, so the applicant’s current job is attached only where the match is unambiguous: the one base-pay JOB line when the checklist has exactly one (payComponent BASE_PAY, or an Ohio employment-type line, which Fortress treats as base pay), or a legacy employment total. Overtime, tips, bonuses and anticipated-increase lines, lines with no pay type, every JOB line of a checklist with several base-pay lines, and every JOB line of a list longer than the cap have no employer details. RECENTLY_ENDED_JOB carries the applicant’s previous job. The job is the one on file as of the last completed certification, not necessarily this line’s certification.

employerAddressstringOptional

Employer street, city, state and ZIP code as one line (e.g. “1 Main St, Austin, TX 78701”).

employerPhonestringOptional
Employer phone number, as entered.
supervisorNamestringOptional
Name of the supervisor at the employer.
jobTitlestringOptional
Position held at the employer.
militaryBranchstringOptional

Branch of service for MILITARY_PAY. Not populated yet: Fortress keeps it only in the raw portal answers.

payerstringOptional

Who pays this income (e.g. the alimony payer). Not populated yet: Fortress keeps it only in the raw portal answers.

sourcestringOptional

Name the applicant gave an OTHER income line (e.g. “Alimony”, “Annuity”).

lineNumberintegerOptional

Position of the line in the checklist list it came from (employment or other income), starting at 1; 1 for single-value lines.

listTruncatedboolean or nullOptional

True when the list on the application holds more items than the API returns. The API returns the first 10 employment lines and the first 12 other-income lines of a checklist. Set on every line read from a list: true when the list holds more, false when it ends within the cap. Empty on lines not read from a list (single-value lines and RECENTLY_ENDED_JOB).

idstringOptionalformat: "uuid"
readableIdstringOptional
idempotencyIdstringOptionalformat: "uuid"
createdAtdatetimeOptional
updatedAtdatetimeOptional
deletedAtdatetimeOptional
applicantIdstringOptionalformat: "uuid"

The applicant record (one per person per application) this line belongs to.

applicationIdstringOptionalformat: "uuid"
certificationIdstringOptionalformat: "uuid"

The certification this line was reported on. Empty for lines reported on an application before it had a certification; read those by applicationId.

householdIdstringOptionalformat: "uuid"
propertyIdstringOptionalformat: "uuid"
organizationIdstringOptionalformat: "uuid"
customerobjectOptional