Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Annual Summary
Organization

Generate Annual Summary Reports for Organization (Batch)

Generate ASR PDFs for all supporters in an organization who made transactions in the specified year. This is an asynchronous operation.

post/organizations/{organization_id}/annual-summary-reports/{year}

Path parameters

organization_idinteger required
Example:1

The specified Organization ID

yearinteger required
Example:2024

The report year

Request body

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

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

Response

Batch generation started

organization_idinteger

Organization ID

report_yearinteger

Report year

statusstring

Current batch status

messagestring

Example response

{
  "organization_id": 1,
  "report_year": 2024,
  "status": "pending",
  "message": "Batch generation started."
}