List collateral schedules, optionally for one lender_id
GET
/ledger/collateral/schedulesA read needs ledger:read or ledger:post.
Query parameters
lender_idstringOptionalReturns
200 OK
dataarray of objectsRequired13 child attributes
classesarray of objectsRequired5 child attributes
asset_classstringRequiredUs_treasury, agency_mbs, residential_mortgage_1_4, commercial_real_estate, commercial_and_industrial, consumer, other
eligiblebooleanRequiredhaircut_bpsintegerRequiredmax_days_past_dueintegerOptionalvaluation_basisstringOptionalMarket_value for securities, unpaid_principal for loans
effective_datestring · dateRequiredA business date, YYYY-MM-DD
excludes_charged_offbooleanRequiredexcludes_nonaccrualbooleanRequiredexcludes_sold_portionbooleanRequiredidintegerRequiredlender_idintegerRequiredmakerstringRequiredmaturity_beyond_advancebooleanRequiredrecorded_atstring · date-timeRequiredreviewobject or nullOptionalReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredsource_refstringRequiredstatusstringRequiredhas_morebooleanRequiredWhether another page follows
Errors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503