Factuarea APIDevelopers
Support
Open app

Duplicate a PDF template

Create a new active template from the current configuration of a source template, which may be archived.

  • Returns 201. - Send name and the expected_version of the source in the body; If-Match is not accepted. - document_kind keeps the kind of the source; transport-document on a commercial source creates a DeCA template with only its preset, layout, branding, typography (8-11 pt), colors and brand. - The copy starts at version 1 without defaults, series or contact preferences.
  • Requires pdf_templates:write; supports Idempotency-Key.
POST
/companies/{company}/pdf-templates/{template}/duplicate

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid
template*string

Public identifier (UUID v7) of the PDF template.

Formatuuid

Headers

Idempotency-Key?string

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Length1 <= length <= 255
Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

Request Body

application/json

Internal reversible write: idempotency follows the current policy; a supplied key is replayed before CAS. Unknown fields are rejected. Until the company is prepared for revisioned templates (tenant initialization pending or revisioned rendering off) every library write returns 422 pdf_presentation_not_ready before any precondition or effect; reads stay available and no Retry-After applies.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Previous/v1/companies/{company}/pdf-template-previews
POST

Create a PDF template preview

Render an illustrative or draft PDF to try a template before using it. document_type and source select what is previewed: example data, an unsaved_form, a persisted_draft, a presentation_revision or an invoice_substitution. It returns the metadata of a preview artifact; read and download it with the PDF artifact operations. A preview never changes a document, numbering or the retained presentation. It counts against the PDF generation budget, so a request without Idempotency-Key is rejected. Requires pdfs:read and pdf_templates:read.

Next/v1/companies/{company}/pdf-templates/contact-defaults/{contact}/{document_type}/{purpose}
PATCH

Set a contact PDF template preference

Set or clear (template_id: null) the template used by default for one contact, document type and purpose. The template must be active and compatible with that type and purpose, and the contact must be a customer. Send the current expected_version in the body or the strong ETag of this preference in If-Match. Omitting template_id keeps the stored value. Requires pdf_templates:write and supports Idempotency-Key.