Skip to main content

IncomeAttributes

Expand fields to inspect their types, constraints and related schemas. Requiredness is defined at each object level.

IncomeAttributesobjectIncomeAttributes ↗
nzRentalVerificationTypeIdinteger · nullableread only

New Zealand only. Rental income verification type ID from the rental-verification-types lookup.

format: int32

nzIsGrossboolean · nullableread only

New Zealand only. Indicates whether Salary / Wages income is gross (true) or net (false).

descriptionstring · nullable

minLength: 0 · maxLength: 500

valuenumber · nullable

format: double

isEvidenceOfTenancyboolean · nullableread only
incomeTypeIdinteger · nullableread only

format: int32

nzRentalTypestring · nullableread only

New Zealand only. Rental income subtype.

Allowed values: "RentalIncome" "BoarderIncome" "FlatmateIncome" null

incomeVerificationstring · nullableread only
frequencyValuestring · nullableread only

Allowed values: "Yearly" "HalfYearly" "Quarterly" "Monthly" "Fortnightly" "Weekly" "HalfMonthly" null

incomeCategorystring · nullableread only
incomeTypestring · nullableread only
updatedstring · nullableread only

format: date-time

createdstring · nullableread only

format: date-time

incomeCategoryIdinteger · nullableread only

format: int32

frequencystring · nullableread only
incomeVerificationIdinteger · nullableread only

An income-verification-types lookup ID.

format: int32