commit 5cec148323aa37293ca0773802a2fc340c309d8b
parent ab24e923870469d7582da042687be2d712bc77f8
Author: Matyja Lukas Adam <lukas.matyja@students.bfh.ch>
Date: Sat, 25 May 2024 18:13:41 +0200
some changes on Donau API
Diffstat:
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/core/api-donau.rst b/core/api-donau.rst
@@ -41,8 +41,9 @@ This is intended to provide a quick overview of the whole REST API. For a more d
The chapters group the families of requests frequently encountered when using the Donau API:
* :ref:`Status information<donau_status>`: get the public signing keys of the Donau, the donation unit key, the Donaus config or some entropy
-* :ref:`Issue receipts<donau_issue>`: For use by charities: Issue receipts for blinded unique donor ids.
-* :ref:`Submit receipts<donau_submit>`: Receive the receipts and, if valid, add all of it's donation units to the donor total. Returns a signature on the total yearly donation amount, hash of taxid+salt and year.
+* :ref:`Issue receipts<donau_issue>`: For use by charities: Issue receipts with blinded unique donor ids from a donor.
+* :ref:`Donation statement<donation_statement>`: Summarizes the donation receipts to the donation statement signature which is made over the total yearly donation amount,
+ the year and the hash of taxid+salt. Provides an API to get the donation statement signature.
* :ref:`Charity administration and status information<donau_charity>`:
* For use by administrators to add/modify a charity
@@ -340,7 +341,7 @@ corresponding charity_id by the Donau.
**Request:** `IssueReceiptsRequest`
**Response:**
-
+
:http:statuscode:`200 OK`:
The request was successful, and the response is a `BSDonationReceipts`.
:http:statuscode:`403 Forbidden`:
@@ -462,7 +463,7 @@ corresponding charity_id by the Donau.
donau_sig: EddsaSignature;
}
-.. _donau_submit:
+.. _donation_statement:
------------------
Donation statement