Loans
Loan object
A loan is an object that lives under an entity, at the same level as a bank account. Just like entities can have multiple bank accounts, entities can have multiple loans. Loans are the foundation for many lending-oriented use cases such as charge cards and term loans. Read more.
Object Parameters
allow_overpayment
booleanIndicates if a loan is able to be overpaid and have a principal_outstanding of less than $0. If false, payments that would result in a loan having a negative balance will be blocked.
auto_sell
booleanIndicates if seasoned principals/interests should be automatically sold to your platform. Default: the value in the loan program.
balances
objectThe loan balances.
interest_paid
stringTotal paid interest in cents belonging to Column and your platform.
interest_receivable
stringTotal outstanding interest receivable in cents for principal belonging to Column and your platform.
principal_charged_off
stringThe charged-off principal receivable.
principal_holding
stringThe principal receivable of the loan which is in a holding state.
principal_outstanding
stringTotal outstanding principal receivable in cents belonging to Column and your platform.
principal_paid
stringThe principal receivable of the loan which has been paid belonging to Column and your platform.
retained_interest_paid
stringTotal paid interest in cents belonging to Column.
retained_interest_receivable
stringTotal outstanding interest receivable in cents for principal belonging to Column.
retained_principal_charged_off
stringThe charged-off principal receivable belonging to Column.
retained_principal_outstanding
stringTotal outstanding principal receivable in cents belonging to Column.
retained_principal_paid
stringTotal paid principal receivable in cents belonging to Column.
servicing_fee_payable
stringTotal outstanding servicing fee payable in cents to your platform.
canceled_at
date-timeThe timestamp the loan was canceled at. Returns null when not applicable.
charged_off_at
date-timeThe timestamp the loan was charged off. Returns null when not applicable.
created_at
date-timeThe timestamp the loan was created
currency
stringThe currency of the loan. Currently only USD is supported.
delinquent_at
date-timeThe timestamp the loan was marked as delinquent. Returns null when not applicable.
description
stringThe description of the loan in the Column dashboard
disputed_at
date-timeThe timestamp the loan was marked as disputed. Returns null when not applicable.
id
stringThe ID of the loan object
interest_config_id
stringID of the interest configuration used to accrue interest receivable daily. The same interest configuration can be shared across multiple loans.
is_business_seasoning_days
booleanIndicates if seasoning_days are business days or calendar days.
is_revolving
booleanIndicates whether or not the loan is revolving. If true the loan can have multiple disbursements.
loan_program_id
stringID of the loan program for this loan.
maturity_date
stringThe maturity date of the loan. It is required if the loan is not revolving.
max_principal_balance
integerThe max principal balance of the loan in cents. This is akin to a credit limit. Disbursements will fail if the resulting principal will be above the max principal.
paid_off_at
date-timeThe timestamp the loan is marked as paid off. Returns null when not applicable.
primary_signer_entity_id
stringThe Column entity_id which the loan is related to
retained_by_column
booleanIndicates if this loan should be retained by Column. Loans retained by Column are not eligible for your platform to purchase.
seasoning_days
integerNumber of days principal receivables will be seasoned.
status
stringThe current status of the loan. Possible values: current, delinquent, charged_off, in_dispute, canceled, paid_off