Skip to main content
POST
Email tax summaries (selected donors or admin recipients)

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
donor_ids
required

Array of donor IDs to summarize, or the literal string all.

Example:
year
integer
required

Tax year the summary covers.

Example:

2025

household_id
integer

Optional household scope for a consolidated household tax summary.

Example:

101

send_to_selected_donors
boolean

When true, emails the donors directly instead of the admin. Defaults to false.

Example:

true

hysform_id

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.

Example:

42

recipients
string<email>[]

Explicit list of email recipients (used when send_to_selected_donors=false). Empty entries are stripped.

Example:

Response

Tax summary generation queued.

message
string
Example:

"Tax summaries are being generated and will be sent shortly."

status
string
Example:

"success"