Exportar factures a un full de càlcul

Exporta una selecció de factures a un full de càlcul (xlsx o csv) i la retorna com a adjunt en streaming.

Acota-la amb els filtres (invoice_ids[], client_id, series_id, status, date_from, date_to, search) o omet-los per exportar-ho tot.
format tria la disposició: SUMMARY (una fila per factura) o ITEMS (una fila per línia).

GET /v1/invoices/export?format=SUMMARY&status=paid&date_from=2026-01-01&date_to=2026-03-31

Límits: la selecció està limitada a 5.000 factures; una de més àmplia retorna 422 export_limit_exceeded.

Clau opaca generada pel client (fins a 255 caràcters; es recomana UUID v7) que permet reintents segurs: la primera resposta s'emmagatzema i es reprodueix en les repeticions sense tornar a executar la mutació. Reutilitzar una clau amb un cos diferent retorna 409 idempotency_key_reused. Consulta la guia d'idempotència. Obligatòria en aquesta operació: repetir-la produeix un efecte irreversible (un correu enviat, un fitxer generat, una crida a un tercer o un càrrec), per la qual cosa una petició sense aquesta capçalera es rebutja amb 422 idempotency_key_required abans d'executar lògica de negoci.

Longitud1 <= length <= 255

Factuarea-Version?string

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.

invoice_ids?array<>|

Llista d'IDs de factura (valors UUID v7) a exportar. Si s'omet, exporta el conjunt que coincideix amb els filtres.

Elementsitems <= 5000

status?|

Estat de factura pel qual filtrar (draft, sent, paid, overdue, cancelled, annulled, scheduled).

date_from?|

Inici del rang de data d'emissió (inclusiu).

Formatdate-time

date_to?|

Fi del rang de data d'emissió (inclusiu).

Formatdate-time

client_id?|

ID de client (valor UUID v7) pel qual filtrar les factures.

Formatuuid

series_id?|

ID de sèrie (valor UUID v7) pel qual filtrar les factures.

search?|

Terme de cerca de text lliure (número, destinatari, sèrie).

Longitudlength <= 255

format?|

Disposició del contingut: SUMMARY (una fila per factura) o ITEMS (una fila per línia).

Valor a"SUMMARY" | "ITEMS" | null

file_format?|

Format de fitxer: xlsx o csv.

Valor a"xlsx" | "csv" | null

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/invoices/export/excel", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-invoices-export_excel"} },  body: JSON.stringify({}),});if (!response.ok) throw new Error(await response.text());await (await import("node:fs/promises")).writeFile("response.bin", new Uint8Array(await response.arrayBuffer()));

Exemple de resposta

Descarrega el fitxer amb les capçaleres de resposta indicades a continuació.

HTTP/1.1 200
Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
Content-Disposition: attachment; filename="FAC-2026-00042.xlsx"

Descarrega el fitxer amb les capçaleres de resposta indicades a continuació.

HTTP/1.1 200
Content-Type: text/csv
Content-Disposition: attachment; filename="FAC-2026-00042.csv"

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

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

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

{
  "error": {
    "type": "invalid_request_error",
    "code": "export_document_cap_exceeded",
    "message": "La descarga empaquetada pide MÁS DOCUMENTOS de los que admite ese tipo de artefacto. No es un límite de peticiones ni un problema de permisos: es el tamaño de lo que se pide en una sola llamada, y el mismo tope rige en la aplicación web y en la API, de modo que partir el trabajo entre superficies no lo esquiva.",
    "doc_url": "https://docs.factuarea.com/guides/errors#export_document_cap_exceeded",
    "request_id": "req_7a0cf558ac315b2b0f7a10d2a9"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_format",
    "message": "La Idempotency-Key debe tener entre 1 y 255 caracteres ASCII printable.",
    "param": "Idempotency-Key",
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_format",
    "request_id": "req_7de4dad17144b3b3ec17b45f3f"
  }
}

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

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

Exportar factures a un full de càlcul

Authorization

Headers

Cos de la petició

Cos de la resposta

200application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

401application/json

403application/json

409application/json

413application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`