Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
reports

Create a new report generation task

To generate a report, pass a template code and parameters in the request body.

The list of available templates and parameters can be found in the List report templates operation.

The template code should be a code field of the template.

The parameters should be a dictionary with keys and values related to the template.

To get a report file, check the status of the task using the List generated reports operation. The file will be available when the status is Completed.

To download the file, use the Download a report operation with the report UUID.

post/billing/org/v1/reports

Request body

template_codestring required

Code of the report template to use for generating the report.

Example request

{
  "parameters": {
    "date_from": "2025-01-01",
    "date_to": "2025-02-01"
  }
}

Response

Resource created successfully.

uuidstring uuid required
created_atstring date-time required

Task creation time

updated_atstring date-time required

Task update time

user_idinteger required
client_idinteger required
task_type'ClosingPeriod' | 'ImportData' | 'Report' | 'StopSubscriptions' required
  • ClosingPeriod - closing_period
  • ImportData - import_data
  • Report - report
  • StopSubscriptions - stop_subscriptions
status'Pending' | 'InProgress' | 'Completed' | 'Failed' | 'Cancelled' required
  • Pending - pending
  • InProgress - in_progress
  • Completed - completed
  • Failed - failed
  • Cancelled - cancelled