Read a retained Federal Reserve interest credit
GET
/ledger/reserve-interest/settlements/{id}Read one recorded credit, its accrued period and its review. A read needs ledger:read or ledger:post.
Path parameters
idstringRequiredReturns
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