Generation API Reference

Use this page when you are implementing a system-to-system connection. For functional setup, start with Connected Systems and Generate Documents.

Request shape

A generation request identifies:

The tenant.
The target environment.
The template or deployed document definition.
Optional variant selection.
The data object that fills the document fields.
Optional output handling, such as where the generated file should be stored or returned.

The exact JSON contract should be taken from the deployed API contract for the Suite version you run. Do not copy example payloads from project notes into production code without checking the current contract.

Result handling

Treat generation as a job. The caller should store the job identifier, poll or subscribe according to the integration pattern, and handle success, validation failure, rendering failure, and cancellation as separate outcomes.

PDF/A output is determined by the deployed template configuration. Do not model archival output as a per-request option unless your integration has an explicit product feature for selecting a different deployed template or variant.

Authorization

Use a dedicated integration identity for each connected system. Grant only the tenant and environment access that the system needs. Rotate credentials as part of normal operational practice.

Validation

Validate against realistic examples before enabling production generation. A technically valid payload can still create a legally or operationally wrong document if the wrong case value is mapped.