Corgi BankDocumentation
OpenAPI

List every version of an advance's structure terms and their reviews, oldest first

GET/ledger/borrowings/{id}/structure-terms

Every version of the advance's structure terms and its review, oldest first; Schedule RC-M items 5.a.(1) to 5.a.(3) read the approved version in force at the report date. A read needs ledger:read or ledger:post.

Path parameters

idstringRequired

Returns

200 OK

dataarray of objectsRequired
12 child attributes
borrowing_idstringRequired
content_sha256stringRequired
effective_datestring · dateRequired

A business date, YYYY-MM-DD

makerstringRequired
optionsarray of objectsRequired
4 child attributes
descriptionstringRequired
exercised_datestring · date or nullOptional

Call or put exercised: the date it repays the advance

first_exercise_datestring · date or nullOptional

Call, conversion and put

kindstringRequired
rate_typestringRequired
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
source_sha256stringRequired
statusstringRequired

Pending_review, approved or rejected

versionintegerRequired
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