Create a proforma

Create a new proforma invoice in `draft` status. Proformas can later be converted to final invoices.

Unique key generated by the client to ensure idempotency on retries. It lets you safely resend the same request: the first response is cached and returned without re-executing the mutation. It is an opaque string to the server; any unique value of up to 64 characters is valid (UUID v7, UUID v4, ULID, nanoid, etc.). UUID v7 is recommended for consistency with the API identifiers. The same key reused with a different body returns 409 idempotency_key_reused.

Length1 <= length <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

client_id*string

Formatuuid

series_id?|

Formatuuid

issued_on*string

Formatdate

valid_until?|

Formatdate

validity_days?|

Range1 <= value <= 365

notes?|

Lengthlength <= 1000

terms_and_conditions?|

Lengthlength <= 2000

reference?|

Lengthlength <= 255

payment_method?|

Lengthlength <= 100

payment_terms?|

Range0 <= value <= 365

shipping_cost?|

Range0 <= value

delivery_terms?|

Lengthlength <= 255

estimated_delivery_date?|

Formatdate

external_id?|

Lengthlength <= 100

currency?|

Value in"EUR"

metadata?|

A free map of up to 50 key→value pairs for storing arbitrary structured data (values are strings up to 500 characters). This is DISTINCT from custom_fields: metadata is an UNORDERED key→value map for opaque integration data, while custom_fields (on the six document resources) is an ORDERED list of typed {field, value} pairs with display semantics. A document may carry both. The master resources (Client, Supplier) have no typed custom_fields: use their metadata as the untyped custom-fields store.

Propertiesproperties <= 50

tags?array<>|

Itemsitems <= 30

custom_fields?array<>|

Itemsitems <= 50

lines*array<>

Items1 <= items

Response Body

`application/json`

import { Factuarea } from "@factuarea/sdk";const factuarea = new Factuarea({ apiKey: process.env.FACTUAREA_API_KEY! });const result = await factuarea.proformas.create({    // request body — see the schema below  });

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a05",
    "object": "proforma",
    "number": "PRO-2026-00007",
    "series": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
      "code": "F-2026"
    },
    "client": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
      "name": "Acme Corporation"
    },
    "status": "draft",
    "issued_on": "2026-01-22",
    "valid_until": "2026-02-21",
    "validity_days": 30,
    "reference": "REF-API-2026-001",
    "converted_to_id": null,
    "converted_invoice_number": "F-2025-003",
    "subtotal": 1500,
    "taxes_total": 315,
    "total_vat": 315,
    "total_retention": 0,
    "total_surcharge": 0,
    "total": 1815,
    "shipping_cost": 15.5,
    "total_with_shipping": 1830.5,
    "currency": "EUR",
    "payment_method": "bank_transfer",
    "payment_terms_days": 30,
    "delivery_terms": "Entrega en 5 dias habiles, portes incluidos",
    "estimated_delivery_date": "2026-06-10",
    "notes": "Proforma pendiente de validación.",
    "terms_and_conditions": "Validez 30 dias. Proforma sin valor fiscal hasta su conversion en factura.",
    "external_id": "ERP-PRO-2026-0007",
    "lines": [
      {
        "object": "proforma_line",
        "description": "Setup inicial",
        "product": {
          "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
          "name": "Consultoría hora estándar"
        },
        "quantity": 1,
        "unit_price": 1500,
        "tax_rate": 21,
        "retention_rate": 0,
        "surcharge_rate": 0,
        "discount_percent": 0,
        "subtotal": 1500,
        "taxes": 315,
        "total": 1815
      }
    ],
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "tags": [
      "exportacion",
      "pendiente-validar"
    ],
    "custom_fields": [
      {
        "field": "incoterm",
        "value": "EXW"
      }
    ],
    "link_expires_at": "2026-07-01T09:53:23+02:00",
    "link_is_active": true,
    "created_at": "2026-01-22T09:10:00Z",
    "updated_at": "2026-01-22T09:10:00Z"
  }
}

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a05",
    "object": "proforma",
    "number": "PRO-2026-00007",
    "series": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a0e",
      "code": "F-2026"
    },
    "client": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
      "name": "Acme Corporation"
    },
    "status": "draft",
    "issued_on": "2026-01-22",
    "valid_until": "2026-02-21",
    "validity_days": 30,
    "reference": "REF-API-2026-001",
    "converted_to_id": null,
    "converted_invoice_number": "F-2025-003",
    "subtotal": 1500,
    "taxes_total": 315,
    "total_vat": 315,
    "total_retention": 0,
    "total_surcharge": 0,
    "total": 1815,
    "shipping_cost": 15.5,
    "total_with_shipping": 1830.5,
    "currency": "EUR",
    "payment_method": "bank_transfer",
    "payment_terms_days": 30,
    "delivery_terms": "Entrega en 5 dias habiles, portes incluidos",
    "estimated_delivery_date": "2026-06-10",
    "notes": "Proforma pendiente de validación.",
    "terms_and_conditions": "Validez 30 dias. Proforma sin valor fiscal hasta su conversion en factura.",
    "external_id": "ERP-PRO-2026-0007",
    "lines": [
      {
        "object": "proforma_line",
        "description": "Setup inicial",
        "product": {
          "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
          "name": "Consultoría hora estándar"
        },
        "quantity": 1,
        "unit_price": 1500,
        "tax_rate": 21,
        "retention_rate": 0,
        "surcharge_rate": 0,
        "discount_percent": 0,
        "subtotal": 1500,
        "taxes": 315,
        "total": 1815
      }
    ],
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "tags": [
      "exportacion",
      "pendiente-validar"
    ],
    "custom_fields": [
      {
        "field": "incoterm",
        "value": "EXW"
      }
    ],
    "link_expires_at": "2026-07-01T09:53:23+02:00",
    "link_is_active": true,
    "created_at": "2026-01-22T09:10:00Z",
    "updated_at": "2026-01-22T09:10:00Z"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "No se ha proporcionado una API key válida en el header Authorization.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_01HKQS5N8VR7QXJ9K3T6BWPMZA"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta API key no tiene el scope requerido para esta operación.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_01HKQS5NBC3P8M1KX4V7SLNHQD"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "La cabecera `Idempotency-Key` ya se usó con un body distinto. Usa una clave nueva o reenvía exactamente el mismo body.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_01HKQS5NHT9A4U7R2E3F8GZWTJ"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "El campo `name` es obligatorio y no puede estar vacío.",
    "param": "name",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid",
    "request_id": "req_01HKQS5NGS8Z3T6Q1D2E7FYVSI"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el rate limit de 60 peticiones por minuto. Reintenta tras 30 segundos.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_01HKQS5NKW1C6W9T4G5H0JBZVL"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Ha ocurrido un error inesperado. Si persiste, contacta con soporte adjuntando el request_id.",
    "param": null,
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_01HKQS5NLX2D7X0U5H6J1KCAWM"
  }
}

Authorization

Header Parameters

Request Body

Response Body

200application/json

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

Missing API key

Invalid API key format

Revoked API key

API key lacks required scope

Plan upgrade required

Required add-on is not active

Idempotency key reused with different body

Generic resource conflict

Parameter failed validation

Plan limit reached (authorization)

Invalid Idempotency-Key format

Modelo 303 without quarter

Modelo 347 with quarter

Year out of range

No invoices in the period

Invalid format

Formatter not available for the type/format/year combination

Signature image too large (>2MB)

Invalid document status transition

Invoice already paid

Quote already accepted

Rate limit exceeded

Too many authentication failures (temporary lockout)

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`