Create a recurring invoice from an invoice

Create a recurring invoice template that reuses the lines, client, and series of an existing invoice, applying the cadence (frequency, start date, optional end date and limits) supplied in the body.

Returns the new recurring invoice.

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

invoice*string

Public identifier (UUID v7) of the invoice.

Formatuuid

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

Presentation policy and relative payment terms preserve omitted/null/empty distinctions. New creation starts at configuration version 1. Creating from an invoice does not copy its overdue calendar or private visual intent. An existing external_id upsert uses update CAS. Saving configuration never resumes a paused recurrence. presentation_policy, payment_terms_template and expected_presentation_policy_version only take effect when revisioned presentation is enabled for the company; otherwise they are ignored.

TypeScript Definitions

Use the request body type in TypeScript.

presentation_policy?|||

Create omitted/null means latest inherited. Update omitted preserves; null resets inheritance; a complete object replaces the policy. {} and partial objects are invalid. This field only takes effect when revisioned presentation is enabled for the company; otherwise it is ignored.

payment_terms_template?array<>|

Relative payment calendar of the recurrence; the schema explains the null, [] and list semantics. This field only takes effect when revisioned presentation is enabled for the company; otherwise it is ignored.

expected_source_context_hash?string

recovery?string

frequency*string

start_on*string

Formatdate

end_on?|

Formatdate

name?|

Lengthlength <= 255

description?string|null

notes?string|null

metadata?|

A free map of up to 50 key→value pairs for storing arbitrary structured data (values are strings up to 500 characters). Unlike custom_fields — an ordered list of typed {field, value} pairs with display semantics, present on the six document resources — metadata is an unordered map for opaque integration data; a document may carry both. The master resources (Client, Supplier) have no custom_fields, so their metadata doubles as the custom-fields store.

Reserved keys (read-only). When the system auto-issues an invoice from a payment correlation (Stripe/GoCardless/MONEI), it writes stripe_subscription_id, stripe_invoice_id, billing_reason, period_start and period_end into that invoice metadata automatically. Do not set or overwrite them by hand — the platform owns them and a manual value may be replaced when the correlation runs.

Propertiesproperties <= 50

holiday_handling?string|null

days_before_due?|

Range0 <= value

max_occurrences?|

Range1 <= value

generation_mode?|

What each run of the recurrence does with the invoice it generates: draft leaves it as a draft; issue issues it (definitive number, VeriFactu record, stock movements) without emailing it; issue_and_send issues it and emails it to the auto_delivery recipients. Any other value is rejected with 422. Optional and nullable: when omitted (or null) the mode is derived from send_automatically (true → issue_and_send, false or absent → draft). When sent, it takes precedence and send_automatically becomes a derived field (true only with issue_and_send); sending a send_automatically (top-level or inside auto_delivery) that contradicts it is rejected with 422. Recipients are only required with issue_and_send: if an auto_delivery object is configured, auto_delivery.recipients must then contain at least one address (422 auto_delivery_recipients_required otherwise); draft and issue send no email and need none. Available in every API version.

Value in"draft" | "issue" | "issue_and_send" | null

auto_delivery?

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/companies/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/invoices/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/create-recurring", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-invoices-create_recurring"} },  body: JSON.stringify({  "frequency": "daily",  "start_on": "2026-03-15"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a08",
    "object": "recurring_invoice",
    "client": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
      "name": "Acme Corporation"
    },
    "series": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
      "code": "F-2026"
    },
    "status": "active",
    "price_list_id": null,
    "price_list_name": null,
    "frequency": "monthly",
    "name": "Cuota mantenimiento mensual Acme",
    "description": "Contrato de soporte y mantenimiento Plan Pro",
    "notes": "Renovación automática. Facturar el día 1 de cada mes.",
    "email_to": "facturacion@acme.example",
    "send_automatically": true,
    "generation_mode": "issue_and_send",
    "days_before_due": 30,
    "max_occurrences": 12,
    "occurrences_count": 0,
    "remaining_occurrences": 12,
    "holiday_handling": "next_business_day",
    "start_on": "2026-01-01",
    "end_on": "2026-12-31",
    "next_run_at": "2026-01-01T09:00:00Z",
    "last_run_at": null,
    "cancelled_at": null,
    "subtotal": "200.00",
    "taxes_total": "42.00",
    "total_vat": "42.00",
    "total_retention": "0.00",
    "total_surcharge": "0.00",
    "total": "242.00",
    "currency": "EUR",
    "lines": [
      {
        "object": "recurring_invoice_line",
        "description": "Cuota soporte mensual",
        "additional_description": null,
        "quantity": 1,
        "unit_price": "200.0000",
        "tax_rate": 21,
        "retention": 0,
        "surcharge": 0,
        "discount_percent": 0,
        "subtotal": "200.00",
        "taxes": "42.00",
        "total": "242.00",
        "exemption_reason": null,
        "regime_key": null,
        "retention_rate_id": null,
        "surcharge_rate_id": null,
        "indirect_tax_regime": null,
        "product_id": null,
        "product_name": null,
        "item_kind": "service",
        "variant_id": null,
        "variant_name": null,
        "presentation_id": null,
        "presentation_name": null,
        "presentation_mode": null,
        "commercial_unit_code": "C62",
        "base_unit_code": "C62",
        "conversion_factor": "1.000000",
        "base_quantity": "1.0000",
        "counted_quantity": null,
        "counted_unit": null,
        "price_list_id": null,
        "price_list_name": null,
        "price_source": "manual",
        "price_unit_code": "C62",
        "configuration": null,
        "options": [],
        "price_semantics": "per_commercial_unit",
        "price_adjustment_total": "0.0000",
        "option_adjustments_absorbed": false,
        "pack_group": null
      }
    ],
    "metadata": {
      "contract": "CTR-2026-0007"
    },
    "external_id": "ERP-REC-2026-0008",
    "tags": [
      "suscripcion",
      "mantenimiento"
    ],
    "custom_fields": [
      {
        "field": "contrato",
        "value": "CTR-2026-0007"
      }
    ],
    "auto_delivery": {
      "send_automatically": true,
      "recipients": [
        "facturacion@acme.example"
      ],
      "cc": [
        "administracion@acme.example"
      ],
      "subject": "Tu factura mensual de Acme",
      "body": "Adjuntamos la factura correspondiente a tu cuota de mantenimiento mensual."
    },
    "created_at": "2025-12-20T15:00:00Z",
    "updated_at": "2025-12-20T15:00:00Z",
    "presentation_policy": {
      "mode": "latest",
      "template_id": null,
      "revision_id": null,
      "commercial_identity_id": null,
      "commercial_identity_revision_id": null
    },
    "payment_terms_template": null,
    "presentation_policy_version": 1,
    "presentation_pause_reason": null
  }
}

Retired X-Active-Profile header sent

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_unknown",
    "subcode": "retired_active_profile_header",
    "message": "La cabecera 'X-Active-Profile' fue retirada de la API v1: la empresa efectiva se indica en el segmento de empresa de la ruta.",
    "param": "X-Active-Profile",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_unknown",
    "request_id": "req_01J8Y3M2Q40000000000000001"
  }
}

Malformed Factuarea-Version header

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_format",
    "message": "El header 'Factuarea-Version' debe tener formato YYYY-MM-DD.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_format",
    "request_id": "req_01J8Y3M2Q40000000000000002"
  }
}

Unsupported Factuarea-Version

{
  "error": {
    "type": "invalid_request_error",
    "code": "unsupported_api_version",
    "message": "La versión de API '2020-01-01' no está soportada.",
    "param": "Factuarea-Version",
    "doc_url": "https://docs.factuarea.com/guides/errors#unsupported_api_version",
    "request_id": "req_01J8Y3M2Q40000000000000003"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_b673bd6011ec3e3ad8660973a4"
  }
}

POST /v1/companies/{company}/invoices/{invoice}/create-recurring · 403 insufficient_scope

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'recurring_invoices:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_7c7a3f5b0fa28171739e75f308"
  }
}

Company deactivated

{
  "error": {
    "type": "authorization_error",
    "code": "company_inactive",
    "message": "Esta empresa está desactivada. Actívala para operar.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#company_inactive",
    "request_id": "req_01J8Y3M2Q40000000000000005"
  }
}

POST /v1/companies/{company}/invoices/{invoice}/create-recurring · 404 invoice_not_found

{
  "error": {
    "type": "not_found_error",
    "code": "invoice_not_found",
    "message": "Factura no encontrada.",
    "param": "invoice_uuid",
    "subcode": "invoice_not_found",
    "doc_url": "https://docs.factuarea.com/guides/errors#invoice_not_found",
    "request_id": "req_2de46fbdfb9b81e97eb8962d38"
  }
}

Company not found or outside the API key scope

{
  "error": {
    "type": "not_found_error",
    "code": "profile_not_found",
    "message": "La empresa indicada no existe o no está en el ámbito de tu credencial.",
    "param": "company",
    "doc_url": "https://docs.factuarea.com/guides/errors#profile_not_found",
    "request_id": "req_01J8Y3M2Q40000000000000004"
  }
}

The document presentation changed

{
  "error": {
    "type": "conflict_error",
    "code": "pdf_presentation_conflict",
    "message": "La presentación documental ha cambiado. Actualiza los datos antes de volver a guardar.",
    "param": "expected_version",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_presentation_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000PPC1"
  }
}

The reviewed presentation context changed

{
  "error": {
    "type": "conflict_error",
    "code": "pdf_presentation_context_changed",
    "message": "El contexto de presentación ha cambiado. Actualiza la vista previa antes de continuar.",
    "param": "expected_preview_context_fingerprint",
    "doc_url": "https://docs.factuarea.com/guides/errors#pdf_presentation_context_changed",
    "request_id": "req_01J8Y3M2Q4CF0000000000PCC1"
  }
}

Concurrent identifier reservation (retryable)

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "Hay otra operación reservando identificadores sobre 'recurring_invoices' en este momento y no ha podido completarse la reserva. Vuelve a intentarlo dentro de unos segundos; la operación es reintentable y no ha dejado nada a medias.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_01J8Y3M2Q4CF0000000000IDR1"
  }
}

POST /v1/companies/{company}/invoices/{invoice}/create-recurring · 422 invalid_param_value

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo frequency es obligatorio.",
    "param": "frequency",
    "errors": [
      {
        "param": "frequency",
        "code": "parameter_missing",
        "message": "El campo frequency es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_f31b979ac544540ca7216433e2"
  }
}

Idempotency key reused with a different payload

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La Idempotency-Key 'order-2026-0001' ya se usó con un payload distinto.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01J8Y3M2Q40000000000000007"
  }
}

Invalid Idempotency-Key format

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_01J8Y3M2Q40000000000000008"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_9cfc07bf537c5943eaea7c74e2"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_67fe4fdfcee758f64acf1ca73f"
  }
}

Create a recurring invoice from an invoice

Authorization

Path Parameters

Headers

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`