Skip to main content

LiabilityAttributes

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

LiabilityAttributesobjectLiabilityAttributes ↗
nzIsInArrearsboolean · nullableread only

New Zealand only. Whether payments are in arrears. Used for all liability types except Buy Now Pay Later.

repaymentnumber · nullable

format: double

valuenumber · nullable

format: double

limitnumber · nullable

format: double

isClearingFromThisLoanboolean · nullableread only

Buy Now Pay Later only. Whether the liability will be cleared from this loan.

accountNamestring · nullable

minLength: 0 · maxLength: 200

accountNumberstring · nullable

minLength: 0 · maxLength: 200

bsbstring · nullable

minLength: 0 · maxLength: 50

interestTaxDeductibleboolean · nullable

Whether interest is tax deductible. Used for Commercial Bill, Hire Purchase, Lease, Line of Credit and Mortgage liabilities.

interestRatenumber · nullable

Interest rate as a percentage; for example, 6.25 represents 6.25%. Used for Commercial Bill, Hire Purchase, Lease, Line of Credit and Mortgage liabilities; in New Zealand, also used for other liability types except Buy Now Pay Later.

format: double

isAccountDetailsKnownboolean · nullable
liabilityTypeIdinteger · nullableread only

format: int32

loanTerminteger · nullable

Mortgage only, outside New Zealand. Loan term in years. New Zealand loans use nzDocumentedLoanTermMonths.

format: int32

liabilitySubTypeIdinteger · nullableread only

Credit Card only. The card type ID from the liability-sub-types lookup.

format: int32

liabilityCategorystring · nullableread only
liabilitySubTypestring · nullableread only

Credit Card only. The display label for liabilitySubTypeId.

liabilityTypestring · nullableread only
nzInterestOnlyTermMonthsinteger · nullableread only

Total interest-only period in months; for example, 30 represents 2 years and 6 months. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

format: int32

nzDocumentedLoanTermMonthsinteger · nullableread only

Total documented loan term in months; for example, 306 represents 25 years and 6 months. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

format: int32

nzInterestOnlyStartDatestring · nullableread only

Start date of the interest-only period. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

format: date

updatedstring · nullableread only

format: date-time

repaymentFrequencyValuestring · nullableread only

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

mortgagePrioritystring · nullableread only

Mortgage only. The priority of the mortgage.

Allowed values: "First" "Second" "Third" null

createdstring · nullableread only

format: date-time

nzRevolvingCreditRedrawboolean · nullableread only

Whether revolving credit or redraw is available. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

nzInterestOnlyEndDatestring · nullableread only

End date of the interest-only period. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

format: date

nzLoanStartDatestring · nullableread only

Loan start date. Used in New Zealand for Personal Loan, Home Loan, Business Loan, Mortgage, Car Loan, Line of Credit and Loan as Guarantor liabilities.

format: date

creditorNamestring · nullableread only
loanRepaymentTypestring · nullableread only

Repayment type. Used for mortgages, and in New Zealand also for Home Loan, Line of Credit and Loan as Guarantor liabilities.

Allowed values: "InterestOnly" "PrincipalInterest" null

liabilityCategoryIdinteger · nullableread only

format: int32

repaymentFrequencystring · nullableread only