Factuarea APIDevelopers

Archive a purchase scan

Archive a scan that is not being processed.

  • Reversible with the restore operation.
  • Requires expected_version.
  • Accepts Idempotency-Key.
DELETE
/companies/{company}/purchase-scans/{purchase_scan}

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