Hand-enter the Federal Reserve's interest credit for an accrued period (treasury staff; the contingency when no Statement of Account arrives, settled only on review)
/ledger/reserve-interest/settlementsRecord the Federal Reserve's credit of the accrued interest, entered by treasury staff. The ledger's guard admits ledger:treasury:write; the store admits only a verified staff person with that scope and a step-up within five minutes. A credit that matches the accrued whole cents settles the period; one that differs is held for independent review. An idempotency key is required.
Headers
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
amountintegerRequiredcurrency_codestringRequiredperiod_endstring · dateRequiredA business date, YYYY-MM-DD
period_startstring · dateRequiredA business date, YYYY-MM-DD
referencestringRequiredReturns
200 OK
accrual_matchedbooleanRequiredThe credit equals the accrual rounded to the cent
accruedstringRequiredThe period's accrual, dollars to eight places
amountintegerRequiredcurrency_codestringRequireddifference_amountintegerRequiredThe credit less that accrual
expected_amountintegerRequiredThat accrual rounded to the cent
idintegerRequiredjournal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
makerstringRequiredmatchedbooleanRequiredSettled when recorded (statement credits before proposals were reviewed)
period_endstring · dateRequiredA business date, YYYY-MM-DD
period_startstring · dateRequiredA business date, YYYY-MM-DD
recorded_atstring · date-timeRequiredreferencestringRequiredreviewobject or nullOptionalReserveReviewRecord is a retained review.
5 child attributes
approvebooleanRequiredcheckerstringRequiredThe verified treasury checker, never the maker
journal_idstringOptionalExample jrnl_2tVh8nqLxq4GbDe0K1F6S9zRcWm
reasonstringRequiredrecorded_atstring · date-timeRequiredsourcestringRequiredFed_statement (the Fed account statement) or treasury (entered by hand)
statement_refstringOptionalstatusstringRequiredErrors
Every error is a problem document with a stable code. See Errors.
400401403404409412413422424429500503