Factuarea APIDevelopers
Soporte
Ir a la app

Subir documentos al escáner de compras

Sube hasta 20 archivos PDF, JPEG o PNG como multipart/form-data (files[], 20 MiB cada uno, 100 MiB por petición).

  • Cada archivo pasa un análisis de seguridad y se almacena cifrado.
  • Se encola para OCR cuando el escaneo automático está activado; de lo contrario, permanece en received hasta que se inicia explícitamente.
  • Responde 202 con accepted[] (índice y detalle completo del escaneo) y rejected[] (índice, nombre del archivo y código de error); 422 cuando no se acepta ningún archivo.
  • Envía un header Idempotency-Key: un reintento devuelve el mismo resultado sin repetir la ingestión.
POST
/purchase_scans

Authorization

AuthorizationBearer <token>

En: header

Headers

Idempotency-Key*string

Clave estable para esta mutación (16–128 caracteres). Reutilízala solo con el mismo payload; después de editar la revisión, inicia una nueva mutación con otra clave.

Longitud16 <= length <= 128
Factuarea-Version?string

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

multipart/form-data

Formulario multipart con una parte por archivo. Cada parte debe llamarse files[]; las partes repetidas sin los corchetes se colapsan en un único archivo por el servidor.

Definiciones de TypeScript

Usa el tipo request body en TypeScript.

Cuerpo de la respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Anterior/v1/purchase_scans/{purchase_scan}/review
PUT

Guardar la revisión de un escaneo de compra

Guarda las correcciones humanas de un escaneo en needs_review: proveedor, cabecera fiscal, líneas y notas, con cada campo marcado como verificado. Requiere expected_version; una versión obsoleta responde 409 y hay que recargar la versión más reciente. Devuelve el escaneo actualizado. Los datos mal formados devuelven 422 antes de comparar la versión.

Siguiente/v1/purchase_scan_emails
GET

Listar correos del escáner de compras

Lista los correos recibidos en el buzón del escáner de compras con remitente, asunto, adjuntos aceptados y rechazados y resultado de la recepción. Busca por remitente o asunto y filtra por resultado de la recepción o intervalo de fechas; paginación por cursor.