List all proformas

List your proforma invoices with cursor-based pagination.

Query Parameters

limit?integer

Number of objects to return. Integer between 1 and 100. Defaults to 25.

Default25

Range1 <= value <= 100

starting_after?string

Cursor for forward pagination. Use the uuid of the last object on the previous page.

Formatuuid

ending_before?string

Cursor for backward pagination. Use the uuid of the first object on the current page.

Formatuuid

status?string

Proforma status. Exact match on status.

status[in]?string

Proforma status. Comma-separated list. Any of the values matches.

client_id?string

Client ID (UUID v7). Exact match on client_id.

Formatuuid

client_id[in]?string

Client ID (UUID v7). Comma-separated list. Any of the values matches.

series_id?string

Series ID (UUID v7). Exact match on series_id.

Formatuuid

series_id[in]?string

Series ID (UUID v7). Comma-separated list. Any of the values matches.

created[gte]?string

Creation date (ISO 8601). Greater than or equal to the given value.

Formatdate-time

created[lte]?string

Creation date (ISO 8601). Less than or equal to the given value.

Formatdate-time

created[gt]?string

Creation date (ISO 8601). Strictly greater than the given value.

Formatdate-time

created[lt]?string

Creation date (ISO 8601). Strictly less than the given value.

Formatdate-time

total[gte]?number

Total amount. Greater than or equal to the given value.

total[lte]?number

Total amount. Less than or equal to the given value.

total[gt]?number

Total amount. Strictly greater than the given value.

total[lt]?number

Total amount. Strictly less than the given value.

number?string

Proforma number. Exact match on number.

number[contains]?string

Proforma number. Partial case-insensitive match (LIKE %term%) on number.

tags?string

Filter by classification tag (lowercase slug). Supports multiple values with tags[in]=a,b (JSON_CONTAINS, OR semantics — matches proformas carrying ANY of the tags). Exact match on tags.

tags[in]?string

Filter by classification tag (lowercase slug). Supports multiple values with tags[in]=a,b (JSON_CONTAINS, OR semantics — matches proformas carrying ANY of the tags). Comma-separated list. Any of the values matches.

sort?string

Sort order. Use a field for ascending or a - prefix for descending (e.g. -created). Allowed fields: created, total, number, valid_until. Combined with the cursor, ordering stays deterministic (a stable secondary sort by the cursor id, Stripe-style). When omitted, results follow the default cursor order (created descending).

search?string

Free-text search. Escaped LIKE %term% (case-insensitive, max 80 chars) across the resource's key text columns, combined with the other filters (AND) and compatible with the cursor.

Lengthlength <= 80

metadata?

Filter by metadata key/value pairs using the deepObject syntax metadata[key]=value. Multiple pairs are combined with AND. Each key must match [A-Za-z0-9_.-]{1,64}; a maximum of 50 pairs is allowed (more → 422).

Headers

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

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

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/proformas?limit=25", {  method: "GET",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json"} },});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-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": {
            "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,
          "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"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

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

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

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "Los parámetros 'starting_after' y 'ending_before' son mutuamente excluyentes.",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_2ddd195b1fcd6b786fe8fd46d0"
  }
}

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

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

List all proformas

Authorization

Query Parameters

Headers

Response Body

200application/json

401application/json

403application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`