Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Annual Summary
Supporter

Generate Annual Summary Report for Supporter

Generate an annual summary report PDF for the specified supporter and return a presigned S3 URL for download

post/supporters/{supporter_id}/annual-summary

Path parameters

supporter_idinteger required
Example:1427264

The specified Supporter ID

Request body

report_yearinteger

The year for the annual summary report

start_datestring date

Start date for the report (optional, defaults to January 1st of report_year)

end_datestring date

End date for the report (optional, defaults to December 31st of report_year)

Example request

{
  "report_year": 2024,
  "start_date": "2024-01-01",
  "end_date": "2024-12-31"
}

Response

Annual summary report download information

download_urlstring

S3 presigned URL for file download

filenamestring

Filename in format GivingSummary_[SupporterName]_YYYY.pdf

expires_atstring

ISO 8601 timestamp when the presigned URL expires

file_sizestring

File size in bytes

content_typestring

MIME type

typestring

File type identifier

Example response

{
  "download_url": "https://s3.amazonaws.com/bucket/file.pdf?presigned-params",
  "filename": "GivingSummary_JohnDoe_2024.pdf",
  "expires_at": "2024-01-02T12:00:00+00:00",
  "file_size": "1048576",
  "content_type": "application/pdf",
  "type": "annual_summary"
}