Previsualizar la factura del tiempo de un proyecto

Previsualiza las líneas de factura que produciría facturar el tiempo seleccionado, sin crear nada: elige entry_ids o un period, y un grouping.

Las imputaciones que no se pueden facturar (no facturables, ya facturadas, sin precio o cuyos importes de línea superarían los límites de la factura) devuelven 422 task_time_not_invoiceable.
Es un POST de solo lectura: no necesita Idempotency-Key.

Fija la versión de la API (YYYY-MM-DD, versionado por fecha estilo Stripe) para esta petición; omítelo para usar la versión fijada de la clave, o la última si no hay ninguna. Versión no soportada → 400 unsupported_api_version; malformada → 400 parameter_invalid_format. La versión efectiva se refleja en la cabecera de respuesta Factuarea-Version. Consulta la guía de Versioning.

Formatodate

X-Active-Profile?string

Opera en nombre de una empresa hija (API key maestra de gestoría): pasa su id público (UUID v7) y la petición se ejecuta contra los datos de esa hija sin cambiar el scope, el tier ni el environment de la clave (omítelo para usar la propia empresa de la clave). UUID inválido → 400 parameter_invalid_uuid; id desconocido o no propio → 404 profile_not_found. Consulta la guía de Acting on behalf.

Formatouuid

Cuerpo de la petición

application/json

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

entry_ids?array<>

Imputaciones de tiempo concretas que facturar (excluyente con period).

Elementos1 <= items <= 500

period?

Periodo, según la fecha de inicio de las imputaciones (excluyente con entry_ids).

grouping*string

Cómo se agrupan las líneas de factura.

Valor en"per_task" | "per_entry" | "single_line"

Cuerpo de la respuesta

`application/json`

Ejemplo de petición

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

Ejemplo de respuesta

{
  "data": {
    "object": "task_time_invoice_preview",
    "project_id": "0193a4f2-7c20-7a11-8b52-4d6e8f0a2c01",
    "customer_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
    "customer_name": "Acme Soluciones SL",
    "grouping": "per_task",
    "lines": [
      {
        "description": "DEV-12 · Integrar la pasarela de pago en el checkout",
        "quantity": "3.5000",
        "unit": "HUR",
        "unit_price": "45.00",
        "amount": "157.50"
      },
      {
        "description": "DEV-14 · Corregir el cálculo del IVA en el carrito",
        "quantity": "3.0000",
        "unit": "HUR",
        "unit_price": "45.00",
        "amount": "135.00"
      }
    ],
    "total_seconds": 23400,
    "total_hours": "6.5000",
    "total_amount": "292.50",
    "entry_ids": [
      "0193a4f2-a1db-7fcc-8a6d-5c7d9e1f3b01",
      "0193a4f2-a1db-7fcc-8a6d-5c7d9e1f3b04"
    ],
    "warnings": []
  }
}

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

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

{
  "error": {
    "type": "not_found_error",
    "code": "project_not_found",
    "message": "Proyecto no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#project_not_found",
    "request_id": "req_17bab80f658a533b33eb536991"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_33066df837851e55ceca5f7a85"
  }
}

POST /v1/projects/{project}/time-invoices/preview · 422 task_time_not_invoiceable

{
  "error": {
    "type": "invalid_request_error",
    "code": "task_time_not_invoiceable",
    "message": "No se pueden facturar las horas: el proyecto no tiene tarifa por hora ni producto de facturación con precio.",
    "doc_url": "https://docs.factuarea.com/guides/errors#task_time_not_invoiceable",
    "request_id": "req_e22148db9dd21b0319b8ed368b"
  }
}

POST /v1/projects/{project}/time-invoices/preview · 422 invalid_time_invoicing_grouping

{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid_value",
    "subcode": "invalid_time_invoicing_grouping",
    "message": "Agrupación no válida: usa per_task, per_entry o single_line.",
    "param": "grouping",
    "doc_url": "https://docs.factuarea.com/guides/errors#parameter_invalid_value",
    "request_id": "req_074386416ce65a9ba5f6580d92"
  }
}

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

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

Previsualizar la factura del tiempo de un proyecto

Authorization

Parámetros de ruta

Headers

Cuerpo de la petición

Cuerpo de la respuesta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Previsualizar la factura del tiempo de un proyecto

Authorization

Parámetros de ruta

Headers

Cuerpo de la petición

Cuerpo de la respuesta

200application/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`