GET /history

Return the finalized year-end donation totals for all charities. The history table stores one record per charity, written when the Donau closes out a donation year for that charity (i.e., when receipts_to_date is rolled over to a new year). Each record gives the final_amount accumulated during donation_year before the rollover occurred.

Only allowed if the request comes with the administrator bearer token.

Request:

Response:

200 OK:

The request was successful, and the response is a HistoryResponse.

204 No Content:

No year-end history records exist yet (no year has been closed out).

403 Forbidden:

The request did not contain an accepted administrator bearer token in its header. Returned with error code TALER_EC_GENERIC_TOKEN_PERMISSION_INSUFFICIENT.

500 Internal Server Error:

The Donau encountered an internal database error. Returned with error code TALER_EC_GENERIC_DB_FETCH_FAILED.

Details:

interface HistoryResponse {
  // Array of year-end totals, one entry per charity that has
  // had at least one year closed out.
  history: CharityYearSummary[];
}

interface CharityYearSummary {

  // Unique ID of the charity within the Donau.
  charity_id: Integer;

  // Total amount of donation receipts issued for this charity
  // during donation_year, recorded at year-end rollover.
  final_amount: Amount;

  // The calendar year to which final_amount applies.
  donation_year: Integer;

}