LiabilityAttributes
Expand fields to inspect their types, constraints and related schemas. Requiredness is defined at each object level.
nzIsInArrearsboolean · nullableread onlyNew Zealand only. Whether payments are in arrears. Used for all liability types except Buy Now Pay Later.
repaymentnumber · nullableformat: double
valuenumber · nullableformat: double
limitnumber · nullableformat: double
isClearingFromThisLoanboolean · nullableread onlyBuy Now Pay Later only. Whether the liability will be cleared from this loan.
accountNamestring · nullableminLength: 0 · maxLength: 200
accountNumberstring · nullableminLength: 0 · maxLength: 200
bsbstring · nullableminLength: 0 · maxLength: 50
interestTaxDeductibleboolean · nullableWhether interest is tax deductible. Used for Commercial Bill, Hire Purchase, Lease, Line of Credit and Mortgage liabilities.
interestRatenumber · nullableInterest 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 · nullableliabilityTypeIdinteger · nullableread onlyformat: int32
loanTerminteger · nullableMortgage only, outside New Zealand. Loan term in years. New Zealand loans use nzDocumentedLoanTermMonths.
format: int32
liabilitySubTypeIdinteger · nullableread onlyCredit Card only. The card type ID from the liability-sub-types lookup.
format: int32
liabilityCategorystring · nullableread onlyliabilitySubTypestring · nullableread onlyCredit Card only. The display label for liabilitySubTypeId.
liabilityTypestring · nullableread onlynzInterestOnlyTermMonthsinteger · nullableread onlyTotal 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 onlyTotal 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 onlyStart 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 onlyformat: date-time
repaymentFrequencyValuestring · nullableread onlyAllowed values: "Yearly" "HalfYearly" "Quarterly" "Monthly" "Fortnightly" "Weekly" "HalfMonthly" null
mortgagePrioritystring · nullableread onlyMortgage only. The priority of the mortgage.
Allowed values: "First" "Second" "Third" null
createdstring · nullableread onlyformat: date-time
nzRevolvingCreditRedrawboolean · nullableread onlyWhether 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 onlyEnd 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 onlyLoan 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 onlyloanRepaymentTypestring · nullableread onlyRepayment 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 onlyformat: int32
repaymentFrequencystring · nullableread only