Cercar una proforma per external ID

Cerca una única proforma pel seu external_id (enviat al body JSON), la clau d'integració que la mapeja a un registre en un sistema de tercers (ERP/CRM/e-commerce).

Retorna la proforma coincident o 404 proforma_not_found si cap proforma fa servir aquest external_id dins de la teva empresa.

Fixa la versió de l'API (YYYY-MM-DD, versionat per data estil Stripe) per a aquesta petició; omet-lo per usar la versió fixada de la clau, o l'última si no n'hi ha cap. Versió no suportada → 400 unsupported_api_version; mal formada → 400 parameter_invalid_format. La versió efectiva es reflecteix a la capçalera de resposta Factuarea-Version. Consulta la guia de Versioning.

Formatdate

X-Active-Profile?string

Opera en nom d'una empresa filla (API key mestra de gestoria): passa el seu id públic (UUID v7) i la petició s'executa contra les dades d'aquella filla sense canviar l'scope, el tier ni l'environment de la clau (omet-lo per usar la pròpia empresa de la clau). UUID no vàlid → 400 parameter_invalid_uuid; id desconegut o no propi → 404 profile_not_found. Consulta la guia d'Acting on behalf.

Formatuuid

Cos de la petició

application/json

Definicions de TypeScript

Usa el tipus request body a TypeScript.

external_id*string

Longitudlength <= 100

Cos de la resposta

`application/json`

Exemple de petició

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/proformas/find-by-external-id", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json"} },  body: JSON.stringify({  "external_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Exemple de resposta

{
  "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",
    "price_list_id": null,
    "price_list_name": null,
    "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",
        "additional_description": "Auditoría inicial e informe de mejoras",
        "product": null,
        "quantity": 1,
        "unit_price": 1500,
        "tax_rate": 21,
        "retention_rate": 0,
        "surcharge_rate": 0,
        "discount_percent": 0,
        "subtotal": 1500,
        "taxes": 315,
        "total": 1815,
        "indirect_tax_regime": null,
        "variant": null,
        "presentation": null,
        "item_kind": null,
        "commercial_unit_code": null,
        "base_unit_code": null,
        "conversion_factor": null,
        "base_quantity": null,
        "price_list_id": null,
        "price_list_name": null,
        "price_source": null,
        "price_unit_code": null,
        "configuration": {
          "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c03",
          "name": "Setup · In situ",
          "signature": "e2704ac1936bd85f0c4a71e2853d69b0fa17c4e6d92038b5417ec0a6395d8b12"
        },
        "options": [
          {
            "group": {
              "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c13",
              "name": "Modalidad"
            },
            "value": {
              "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8c23",
              "name": "In situ"
            },
            "price_adjustment": "250.0000",
            "applied": true
          }
        ],
        "price_semantics": "per_commercial_unit",
        "price_adjustment_total": "250.0000",
        "option_adjustments_absorbed": false
      }
    ],
    "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": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_0fa9ea7b49fae472087694b66a"
  }
}

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

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "La operación chocó con el estado actual del recurso y no aplica ningún código de conflicto más específico.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_4fdbe484d76af8ea0a613716ad"
  }
}

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

{
  "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_8c09f712ca6d1345d8ea1b1efd"
  }
}

{
  "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_7f7c9a05ab35ba081e061a5c73"
  }
}

Cercar una proforma per external ID

Authorization

Headers

Cos de la petició

Cos de la resposta

200application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`