> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Email tax summaries (selected donors or admin recipients)

> Generates and queues delivery of year-end tax summary letters via `MailingGenerationService`. The delivery mode is derived from inputs: `email_selected_donors` when `send_to_selected_donors=true`, `email_explicit` when an explicit `recipients` list is supplied, otherwise `email_admin` (the calling admin gets the summary). `donor_ids` accepts an array of integer ids OR the literal string `all`; when `all` is combined with `send_to_selected_donors=true`, `hysform_id` becomes required. Returns 200 once the generation is queued. Requires permission: `mailings_generate` (also satisfied by `mailings_manage` or `manage_email`).



## OpenAPI

````yaml post /admin/donors/send_tax_summary
openapi: 3.0.0
info:
  title: Gratona API
  description: >-
    REST API for the Gratona fundraising platform, including donor, donation,
    sponsorship, program, event, and integration workflows. Endpoints are
    organized by tag. Most endpoints require either a Passport bearer token or
    an issued API key — see the Security Schemes section.
  contact:
    name: Gratona Engineering
    url: https://gratona.com
    email: devs@gratona.com
  version: 1.0.0
servers:
  - url: https://api.gratona.com/v1
    description: Server Version 1.0.0
security: []
tags:
  - name: Auth
    description: >-
      Login, signup, logout, password reset, and email verification for admin
      users and donors.
  - name: Donors
    description: >-
      Donor records: CRUD, profile fields, household linkage, search, filters,
      merge, and duplicate detection.
  - name: Donations
    description: >-
      Individual donation records, recurring commitments, soft credits, refunds,
      designations, and exports.
  - name: Sponsorships
    description: >-
      Donor-to-entity sponsorship relationships, lifecycle transitions, and
      sponsorship-specific filters.
  - name: Entities
    description: >-
      Recipient records (children, families, projects, animals, etc.), their
      status, and entity-level fields.
  - name: Programs
    description: >-
      Program / campaign configuration: hierarchy, settings, and program-level
      metadata.
  - name: Forms
    description: >-
      Custom form builder (HysForm), form fields, standardized donor fields, and
      field migrations.
  - name: Trips
    description: >-
      Mission-trip management: trips, participants, budgets, tasks,
      e-signatures, fundraising milestones, and background checks.
  - name: Communications
    description: >-
      Email templates, SMS, newsletters, donor email manager, and per-donor
      notes.
  - name: Payments
    description: >-
      Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks).
      Excludes inbound webhooks — see the Webhooks tag.
  - name: Reports
    description: Dashboards, analytics, scheduled reports, and exports.
  - name: Admin
    description: >-
      Client-account administration: users, groups/permissions, settings,
      integrations, and account lifecycle.
  - name: Donor Portal
    description: >-
      Endpoints consumed by the donor-facing portal (donor login, dashboard,
      donation history, messages).
  - name: Recipient Portal
    description: Endpoints consumed by the recipient-facing portal.
  - name: Public
    description: >-
      Unauthenticated public endpoints: donor signup, public trip pages,
      peer-to-peer campaigns, public checkout.
  - name: Webhooks
    description: >-
      Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr,
      DropboxSign). Annotated minimally for reference; payload shapes are owned
      by the upstream provider.
  - name: Client
    description: Client
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Files
    description: Files
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
paths:
  /admin/donors/send_tax_summary:
    post:
      tags:
        - Donations
      summary: Email tax summaries (selected donors or admin recipients)
      description: >-
        Generates and queues delivery of year-end tax summary letters via
        `MailingGenerationService`. The delivery mode is derived from inputs:
        `email_selected_donors` when `send_to_selected_donors=true`,
        `email_explicit` when an explicit `recipients` list is supplied,
        otherwise `email_admin` (the calling admin gets the summary).
        `donor_ids` accepts an array of integer ids OR the literal string `all`;
        when `all` is combined with `send_to_selected_donors=true`, `hysform_id`
        becomes required. Returns 200 once the generation is queued. Requires
        permission: `mailings_generate` (also satisfied by `mailings_manage` or
        `manage_email`).
      operationId: 2410b8f6ed5d38ce57e8c95d5948b734
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - donor_ids
                - year
              properties:
                donor_ids:
                  description: >-
                    Array of donor IDs to summarize, or the literal string
                    `all`.
                  oneOf:
                    - type: array
                      items:
                        type: integer
                      example:
                        - 12345
                        - 12346
                    - type: string
                      enum:
                        - all
                      example: all
                year:
                  description: Tax year the summary covers.
                  type: integer
                  example: 2025
                household_id:
                  description: >-
                    Optional household scope for a consolidated household tax
                    summary.
                  type: integer
                  example: 101
                send_to_selected_donors:
                  description: >-
                    When true, emails the donors directly instead of the admin.
                    Defaults to false.
                  type: boolean
                  example: true
                hysform_id:
                  description: >-
                    Donor form to scope `donor_ids=all` to. Required when
                    `donor_ids=all` and `send_to_selected_donors=true`. May also
                    be the literal string `all`.
                  oneOf:
                    - type: integer
                      example: 42
                    - type: string
                      enum:
                        - all
                recipients:
                  description: >-
                    Explicit list of email recipients (used when
                    `send_to_selected_donors=false`). Empty entries are
                    stripped.
                  type: array
                  items:
                    type: string
                    format: email
                  example:
                    - finance@example.org
              type: object
      responses:
        '200':
          description: Tax summary generation queued.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: >-
                      Tax summaries are being generated and will be sent
                      shortly.
                  status:
                    type: string
                    example: success
                type: object
        '400':
          description: >-
            `year` missing, `donor_ids` empty/non-array, or `hysform_id`
            required for `donor_ids=all` mode but absent.
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Year is required.
                  status:
                    type: string
                    example: error
                type: object
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
        '403':
          description: '`hysform_id` does not belong to the caller''s client.'
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: Invalid donor form selected.
                  status:
                    type: string
                    example: error
                type: object
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    UnauthorizedResponse:
      title: UnauthorizedResponse
      description: >-
        Returned with HTTP 401 when the request lacks a valid Passport bearer
        token, a valid `X-HYS-API-Key`, or a valid session. The body is the
        simple `{message, status}` envelope emitted by `AuthenticateApiOrKey`.
      required:
        - message
        - status
      properties:
        message:
          description: >-
            Always the literal string `Unauthorized` from the `auth.api_or_key`
            middleware. Login endpoints return `Invalid Credentials` instead.
          type: string
          example: Unauthorized
        status:
          type: string
          example: error
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.