Factuarea APIDevelopers
Support
Open app

Upload documents to the purchase scanner

Upload up to 20 PDF, JPEG or PNG files as multipart/form-data (files[], 20 MiB each, 100 MiB per request).

  • Each file is scanned for safety and stored encrypted.
  • It is queued for OCR when automatic scanning is enabled; otherwise it remains received until explicitly started.
  • Responds 202 with accepted[] (index plus the full scan detail) and rejected[] (index, filename, error code); 422 when no file was accepted.
  • Send an Idempotency-Key header: a replay returns the same result without re-ingesting.
POST
/purchase_scans

Authorization

AuthorizationBearer <token>

In: header

Headers

Idempotency-Key*string

Stable key for this mutation (16–128 characters). Reuse it only with the same payload; after editing the review, start a new mutation with a new key.

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

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate
X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

multipart/form-data

Multipart form with one part per file. Every part must be named files[]; repeated parts without the brackets are collapsed into a single file by the server.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

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

Save the review of a purchase scan

Persist the human corrections of a scan in needs_review: supplier, fiscal header, lines and notes, each field marked as verified. Requires expected_version; a stale version responds 409 and the latest version must be reloaded. Returns the updated scan. Malformed payloads return 422 before version comparison.

Next/v1/purchase_scan_emails
GET

List purchase scanner emails

List the emails received in the purchase scanner mailbox with sender, subject, accepted and rejected attachments and ingestion result. Search by sender or subject and filter by ingestion result or date range; cursor-based pagination.