Skip to content
ZUTAX ZUTAX Documentation

Generate report

POST
/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/reports

Generate new tax report with real data aggregation. Permissions: report:create

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Workspace-ID
Any of:
string
X-API-Key
Any of:
string
X-Tenant-ID
Any of:
string

Request Body required

Section titled “Request Body required ”
ReportCreate

Create report request.

object
report_type
required
ReportType

Types of compliance reports.

string
Allowed values: monthly_vat quarterly_vat annual_tax e_invoice_summary transaction_log custom
report_name
required
Report Name
string
<= 255 characters
period_start
required
Period Start
string format: date
period_end
required
Period End
string format: date
parameters
Any of:
object
key
additional properties
any
format
Format
string
default: pdf /^(pdf|excel)$/
Examples

Report generation request

{
  "report_type": "MONTHLY_VAT",
  "report_name": "VAT Monthly Jan 2026",
  "period_start": "2026-01-01",
  "period_end": "2026-01-31",
  "parameters": {
    "format": "csv",
    "include_credit_notes": true,
    "submitted_by": "finance.lead@getzutax.com"
  }
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful Response

Examples

Report generation accepted

{
  "id": "f29ac55b-bf47-422f-a82b-c488b90e31f3",
  "report_reference": "RPT-2026-0001",
  "report_type": "MONTHLY_VAT",
  "report_name": "VAT Monthly Jan 2026",
  "period_start": "2026-01-01",
  "period_end": "2026-01-31",
  "status": "QUEUED",
  "total_invoices": 0,
  "total_credit_notes": 0,
  "total_amount": null,
  "format": "pdf",
  "error_message": null,
  "parameters": {},
  "payloads": [],
  "created_at": "2026-02-16T08:00:00Z",
  "updated_at": "2026-02-16T08:00:00Z"
}

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}