Previsualitzar la factura del temps d'un projecte

Previsualitza les línies de factura que produiria facturar el temps seleccionat, sense crear res: tria entry_ids o un period, i un grouping.

Les imputacions que no es poden facturar (no facturables, ja facturades, sense preu o els imports de línia de les quals superarien els límits de la factura) retornen 422 task_time_not_invoiceable.
És un POST de només lectura: no necessita Idempotency-Key.

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.

entry_ids?array<>

Imputacions de temps concretes que cal facturar (excloent amb period).

Elements1 <= items <= 500

period?

Període, segons la data d'inici de les imputacions (excloent amb entry_ids).

grouping*string

Com s'agrupen les línies de factura.

Valor a"per_task" | "per_entry" | "single_line"

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/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());

Exemple de resposta

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

Previsualitzar la factura del temps d'un projecte

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Previsualitzar la factura del temps d'un projecte

Authorization

Paràmetres de ruta

Headers

Cos de la petició

Cos de la resposta

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`