The Loan Product object
Product is one version of a product definition.
Attributes
allow_negativebooleanRequiredanalysisobject or nullOptionalBusiness analysis checking: earnings credit against fees
2 child attributes
earnings_credit_bpsintegerRequiredper_item_fee_minorintegerRequiredcodestringRequiredcurrencystringRequiredcustomer_typestringRequiredfamilystringRequiredfeesarray of objectsRequired5 child attributes
amount_minorintegerRequiredkindstringRequiredtriggerstringRequiredMonthly, or per_event_* (assessed by the service that sees the event)
waiver_methodstringOptionalHow the minimum balance is measured, as disclosed under Reg DD 1030.4(b)(4)(ii): daily (every day of the cycle) or average_daily
waiver_min_balance_minorintegerRequiredgl_codestringRequiredinterestobject or nullOptionalInterest terms of a deposit product.
6 child attributes
accrualstringRequiredannual_rate_bpsintegerRequiredday_countstringRequiredpostingstringRequiredtieringobject or nullOptional2 child attributes
methodstringRequiredWhole_balance (Reg DD method A) or marginal (method B)
tiersarray of objectsRequired2 child attributes
annual_rate_bpsintegerRequiredminimum_balance_minorintegerRequiredvariablebooleanRequiredkindstringRequiredledger_namespacestringRequiredlendingobject or nullOptionalLending terms of a loan product.
15 child attributes
allowanceobject or nullOptionalThe CECL loss-rate table
5 child attributes
30_59_bpsintegerRequired60_89_bpsintegerRequired90_plus_bpsintegerRequiredcurrent_bpsintegerRequirednonaccrual_bpsintegerRequiredcharge_off_daysintegerRequiredDays past due at which the balance is charged off against the allowance (120 for closed-end consumer credit)
escrowbooleanOptionalThe instalment carries an escrow for taxes and insurance (mortgages)
facilityobject or nullOptionalA credit facility rather than an instalment loan
21 child attributes
advance_bpsintegerOptionalFactoring, floor plan, warehouse: advance against the item's face
borrowing_basebooleanOptionalAvailability is the lesser of the limit and the certified base
converts_to_product_codestringOptionalConstruction: the permanent loan product
curtailment_bpsintegerOptionalFloor plan: share of the advance due at each curtailment
curtailment_daysintegerOptionalFloor plan: days until the first principal curtailment
draw_period_monthsintegerOptionalRevolving: draws allowed for this long; 0 is open-ended
expiry_monthsintegerOptionalLetters of credit
factor_rate_bpsintegerOptionalMerchant cash advance: owed = purchase × factor
fee_bpsintegerOptionalLetters of credit: annual fee; factoring: per invoice
holdback_bpsintegerOptionalMerchant cash advance: share of card receipts remitted
interest_onlybooleanOptionalinventory_advance_bpsintegerOptionalmax_days_on_lineintegerOptionalFactoring, floor plan, warehouse: an item outstanding longer is past due
min_payment_bpsintegerOptionalRevolving: the principal share of the minimum payment
min_payment_floor_minorintegerOptionalRevolving: the minimum payment floor
payment_due_daysintegerOptionalDays after the statement the payment is due (the CARD Act's 21-day floor)
receivables_advance_bpsintegerOptionalrecoursebooleanOptionalFactoring: the client stands behind uncollected invoices
repayment_monthsintegerOptionalRevolving: the amortising period after the draw period
secured_bystringOptionaltypestringRequiredRevolving, construction, letter_of_credit, factoring, floor_plan, merchant_cash_advance, warehouse
grace_daysintegerRequiredguaranteeobject or nullOptionalA government guarantee on the loan (SBA 7(a), 504, USDA)
2 child attributes
guaranteed_bpsintegerRequiredprogramstringRequiredSba_7a, sba_504, usda
late_fee_minorintegerRequiredmax_dti_bpsintegerRequiredmax_principal_minorintegerRequiredmax_term_monthsintegerRequiredmin_credit_scoreintegerRequiredmin_principal_minorintegerRequiredmin_term_monthsintegerRequirednonaccrual_daysintegerRequiredDays past due at which accrual stops and uncollected interest is reversed (90 is the general trigger)
origination_fee_bpsintegerRequiredlimitsobjectRequiredLimits on money movement for the product.
2 child attributes
daily_minorintegerRequiredper_transaction_minorintegerRequirednamestringRequirednow_notice_daysintegerOptionalposting_policyobject or nullOptionalPostingPolicy describes the order the running ledger actually enforces. New ordering mechanisms require an engine change; arbitrary amount sorting is not a supported setting.
2 child attributes
orderstringRequiredversionintegerRequiredregulatoryobject or nullOptionalWhere the product's balances report: Call Report items and the FR 2900 class
7 child attributes
fr2900_classstringOptionalDeposits: transaction, savings (money market included) or time
interest_bearingbooleanOptionalDeposits: RC 13.a.(2) when true, 13.a.(1) when not
rc_c_itemstringOptionalLoans: the Schedule RC-C loan category, 4.a commercial and industrial, 6.c other consumer
rc_e_columnstringOptionalDeposits: transaction or nontransaction (Schedule RC-E columns)
rc_e_itemstringOptionalDeposits: the RC-E depositor line, 1 for individuals, partnerships and corporations
rc_n_categorystringOptionalLoans: the Schedule RC-N line, the same category as RC-C unless the schedule splits it
ri_itemstringOptionalThe Schedule RI income or expense item the product's interest reports on
sourcestringRequiredstatement_cyclestringRequiredstatusstringRequiredtermobject or nullOptionalCertificates of deposit: the term, penalty and what happens at maturity
9 child attributes
at_maturitystringRequiredRollover or pay_out
brokerstringOptionalThe deposit broker of record
brokeredbooleanRequiredDeposits taken through an intermediary (RC-E memoranda)
early_withdrawal_penaltystringRequiredDays_of_interest
grace_daysintegerRequiredDays after maturity to withdraw without penalty
minimum_deposit_minorintegerOptionalThe smallest opening deposit, in minor units; 0 means none. Enforced by accounts at funding
monthsintegerRequiredpenalty_daysintegerRequiredDays of simple interest forfeited on early withdrawal
rollover_product_codestringRequiredThe product the balance rolls into (often itself)
transfer_limitobject or nullOptionalMoney market and savings: the convenient-transfer limit, when the bank keeps one
3 child attributes
enforcementstringRequiredRefuse or fee
excess_fee_minorintegerRequiredper_statement_cycleintegerRequired0 means no limit
typestringOptionalDeposit products: checking, now, savings, money_market, certificate
versionintegerRequired