Corgi BankDocumentation
OpenAPI

A facility's draws and financed items

GET/facilities/{id}/draws

Path parameters

idstringRequired

Returns

200 OK

dataarray of objectsRequired
17 child attributes
amountintegerRequired
business_datestring · dateRequired

A business date, YYYY-MM-DD

created_atstring · date-timeRequired
curtailment_amountintegerOptional

Floor plan: principal due at each curtailment date

curtailment_daysintegerOptional
descriptionstringOptional
due_datestring · date or nullOptional

A business date, YYYY-MM-DD

face_amountintegerOptional
facility_idstringRequired
idstringRequired
itemobject or nullOptional

CollateralItem is an invoice, vehicle or mortgage note financed by a draw.

6 child attributes
debtorstringOptional
descriptionstringOptional
due_datestringOptional
face_amountintegerRequired
kindstringOptional
referencestringRequired
journal_idstringRequired

Example jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm

kindstringRequired
referencestringOptional
reserve_amountintegerOptional
settled_amountintegerRequired
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