taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-donau-statements.rst (1394B)


      1 .. ts:op:: getDonauStatements
      2 
      3   Get a list of donation statements for this wallet.  Both donation
      4   statements for the currently configured donation authority as well
      5   as past configurations (if they exist) are returned.
      6 
      7   **Request:**
      8 
      9   The request arguments must be a `GetDonauStatementsRequest`
     10   object.
     11 
     12   **Response:**
     13 
     14   On success, the result is a `GetDonauStatementsResponse` object.
     15 
     16   **Side effects:**
     17 
     18   Submits all pending donation receipts to the respective donation
     19   authority over the network and marks them as submitted in the
     20   wallet database, emitting a balance-change notification, before
     21   the statements are fetched.
     22 
     23   **Details:**
     24 
     25   A statement is requested from every donation authority (or only
     26   from the one named by ``donauBaseUrl``, if given) for each year
     27   with submitted receipts; years for which the authority has not yet
     28   issued a statement contribute no entry to the result.
     29 
     30 .. ts:def:: GetDonauStatementsRequest
     31 
     32   interface GetDonauStatementsRequest {
     33     donauBaseUrl?: string;
     34   }
     35 
     36 .. ts:def:: GetDonauStatementsResponse
     37 
     38   interface GetDonauStatementsResponse {
     39     statements: DonauStatementItem[];
     40   }
     41 
     42 .. ts:def:: DonauStatementItem
     43 
     44   interface DonauStatementItem {
     45     total: AmountString;
     46     year: number;
     47     legalDomain: string;
     48     uri: string;
     49     donationStatementSig: EddsaSignatureString;
     50     donauPub: EddsaPublicKeyString;
     51   }