Corgi BankDocumentation
OpenAPI

List collateral schedules, optionally for one lender_id

GET/ledger/collateral/schedules

A read needs ledger:read or ledger:post.

Query parameters

lender_idstringOptional

Returns

200 OK

dataarray of objectsRequired
13 child attributes
classesarray of objectsRequired
5 child attributes
asset_classstringRequired

Us_treasury, agency_mbs, residential_mortgage_1_4, commercial_real_estate, commercial_and_industrial, consumer, other

eligiblebooleanRequired
haircut_bpsintegerRequired
max_days_past_dueintegerOptional
valuation_basisstringOptional

Market_value for securities, unpaid_principal for loans

effective_datestring · dateRequired

A business date, YYYY-MM-DD

excludes_charged_offbooleanRequired
excludes_nonaccrualbooleanRequired
excludes_sold_portionbooleanRequired
idintegerRequired
lender_idintegerRequired
makerstringRequired
maturity_beyond_advancebooleanRequired
recorded_atstring · date-timeRequired
reviewobject or nullOptional

ReviewRecord is a retained review.

5 child attributes
approvebooleanRequired
checkerstringRequired
journal_idstringOptional

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

reasonstringRequired
recorded_atstring · date-timeRequired
source_refstringRequired
statusstringRequired
has_morebooleanRequired

Whether another page follows

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

to move to open esc to close