Factuarea APIDevelopers
Suport
Ves a l'app

Pujar documents a l’escàner de compres

Puja fins a 20 arxius PDF, JPEG o PNG com a multipart/form-data (files[], 20 MiB cadascun, 100 MiB per petició).

  • Cada arxiu passa una anàlisi de seguretat i s’emmagatzema xifrat.
  • Es posa a la cua per a OCR quan l’escaneig automàtic està activat; en cas contrari, roman en received fins que s’inicia explícitament.
  • Respon 202 amb accepted[] (índex i detall complet de l’escaneig) i rejected[] (índex, nom de l’arxiu i codi d’error); 422 quan no s’accepta cap arxiu.
  • Envia un header Idempotency-Key: un reintent retorna el mateix resultat sense repetir la ingestió.
POST
/purchase_scans

Authorization

AuthorizationBearer <token>

A: header

Headers

Idempotency-Key*string

Clau estable per a aquesta mutació (16–128 caràcters). Reutilitza-la només amb el mateix payload; després d’editar la revisió, inicia una nova mutació amb una altra clau.

Longitud16 <= length <= 128
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ó

multipart/form-data

Formulari multipart amb una part per arxiu. Cada part s'ha d'anomenar files[]; les parts repetides sense claudàtors es col·lapsen en un únic arxiu pel servidor.

Definicions de TypeScript

Usa el tipus request body a TypeScript.

Cos de la resposta

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

Desar la revisió d’un escaneig de compra

Desa les correccions humanes d’un escaneig en needs_review: proveïdor, capçalera fiscal, línies i notes, amb cada camp marcat com a verificat. Requereix expected_version; una versió obsoleta respon 409 i cal tornar a carregar la versió més recent. Retorna l’escaneig actualitzat. Les dades mal formades retornen 422 abans de comparar la versió.

Següent/v1/purchase_scan_emails
GET

Llistar correus de l’escàner de compres

Llista els correus rebuts a la bústia de l’escàner de compres amb remitent, assumpte, adjunts acceptats i rebutjats i resultat de la recepció. Cerca per remitent o assumpte i filtra per resultat de la recepció o interval de dates; paginació per cursor.