Record the next version of an advance's fixed-rate structure terms (call, conversion, put, cap, floor or other embedded derivative) from an effective date, pending independent review (treasury staff)
/ledger/borrowings/{id}/structure-termsThe ledger's guard admits ledger:treasury:write on this route and refuses ledger:post; the store admits only verified treasury staff (never a service or an API key) who stepped up within five minutes. Records the next version of an advance's terms from effective_date (on or after the draw, before maturity): rate_type fixed (a floating rate is refused 422: the ledger accrues each advance at one annual rate with no repricing), one options entry per kind the agreement contains (call, conversion or put with its first exercise date; cap, floor or other_embedded_derivative), an empty list attesting none, and the agreement's source_ref and SHA-256. A call the lender exercised or a put the bank exercised carries exercised_date, the date it repays the advance, in a version effective from the notice (on or after the first exercise date, on or before maturity, at most one per version); a conversion has none, since a converted advance floats. Schedule RC-M item 5.a reports such an advance by its exercise date and a convertible one by its next conversion date. The database refuses the same option records. A version waiting for review, or one not effective after the approved version, is refused 409 conflict. The same key and terms replay; other terms under the key are 409.
Path parameters
idstringRequiredHeaders
Idempotency-KeystringRequiredSend on every write that creates or changes money or state; a replay with the same key returns the original result with 200.
Body parameters
effective_datestring · dateRequiredA business date, YYYY-MM-DD
optionsarray of objectsRequired4 child attributes
descriptionstringRequiredexercised_datestring · date or nullOptionalCall or put exercised: the date it repays the advance
first_exercise_datestring · date or nullOptionalCall, conversion and put
kindstringRequiredrate_typestringRequiredFixed; floating is refused
source_refstringRequiredsource_sha256stringRequiredReturns
200 OK
borrowing_idstringRequiredcontent_sha256stringRequiredeffective_datestring · dateRequiredA business date, YYYY-MM-DD
makerstringRequiredoptionsarray of objectsRequired4 child attributes
descriptionstringRequiredexercised_datestring · date or nullOptionalCall or put exercised: the date it repays the advance
first_exercise_datestring · date or nullOptionalCall, conversion and put
kindstringRequiredrate_typestringRequiredrecorded_atstring · date-timeRequiredreviewobject or nullOptionalReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredsource_refstringRequiredsource_sha256stringRequiredstatusstringRequiredPending_review, approved or rejected
versionintegerRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503