Factuarea APIDevelopers
Support
Open app

Create the expense from a scan

Create exactly one draft expense from a reviewed scan and link it.

  • Responds 200 on the first call and on replays, returning the same linked expense.
  • Requires expected_version and that no blocking issue remains; otherwise 422.
POST
/companies/{company}/purchase-scans/{purchase_scan}/convert

Authorization

AuthorizationBearer <token>

Your API key as a bearer token: fact_live_… in production, fact_test_… in sandbox. See the authentication guide.

In: header

Path Parameters

company*string

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Formatuuid
purchase_scan*string

Public identifier (UUID v7) of the purchase scan.

Formatuuid

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

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

application/json

application/json

Previous/v1/companies/{company}/purchase-scans/stats
GET

Get purchase scanner stats

Aggregated counters of the purchase scanner for your company: documents in progress, pending review and with incidents, plus per-status counts. Returned as { "data": PurchaseScanStats }.

Next/v1/companies/{company}/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.