Factuarea APIDevelopers
Support
Open app

Restore an archived purchase scan

Return an archived scan to its previous restorable state; interrupted processing resumes from queued, and interrupted automatic conversion returns to needs_review.

  • Check available_actions before reviewing or converting; restoring does not recover a purged original.
  • Requires expected_version.
  • Accepts Idempotency-Key.
POST
/purchase_scans/{purchase_scan}/restore

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

purchase_scan*string

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

application/json

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

Previous/v1/purchase_scans/{purchase_scan}/duplicate_resolution
POST

Resolve a duplicate purchase scan

Resolve a scan in duplicate status with resolution = link_existing (link the existing expense) or archive. Duplicate overrides require an authorised user in the Factuarea app; they are not available through the public API or MCP. Requires expected_version. Accepts Idempotency-Key.

Next/v1/purchase_scans/{purchase_scan}/retry
POST

Retry a failed purchase scan

Start OCR for a scan in received, or queue it again for a scan in failed whose error is recoverable. Requires expected_version; a stale version responds 409. Accepts Idempotency-Key.