Deprecated endpoint
This endpoint will be removed in a future version. Migrate to the recommended replacement.
payments_reports:createUser IDDeprecated. Payment reports have moved to their own surface — use POST /v1/payment-reports (generatePaymentReport). This route is retained for existing integrations; it will be removed after a deprecation window.
Initiate generation of a new payment report for the specified date range; all parameters
are read from the query string. The report is created In-progress and filled in
asynchronously. The date range cannot exceed 365 days. If no group is specified, the
report covers all groups.
start_timedate-timeStart time for the report in ISO 8601 UTC format.
end_timedate-timeEnd time for the report in ISO 8601 UTC format. Must not be before start_time (422),
and the range cannot exceed 365 days (400).
groupstringGroup to generate the report for, by id (ThingsGroupId_…) or name. If omitted, the report
covers all groups. Returns 404 if the specified group is not found.
webhookuriHTTPS callback URL notified once, on successful completion only, with the finished
report. Same behaviour as the webhook body field on POST /v1/payment-reports —
see that operation's paymentReportCompleted callback for the payload and its
caveats (unauthenticated, no retry, may be multi-MB). Anything but an https:// URL
is rejected with 422. Omit for polling-only.
Report generation initiated successfully
HTTP status code
Response message
Response returned when a payment report generation is initiated.
Current status of the report generation
Human-readable status message
Unique identifier for the created report
Unique request ID for tracking
Example
{
"status_code": 201,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"status": "in_progress",
"message": "Report generation in progress",
"report_id": "507f1f77bcf86cd799439011"
}
}Was this page helpful?