Purchase Scans

List purchase scans

List the documents received by the purchase scanner (upload, API or mailbox) with their lifecycle status, extraction issues and available_actions. Use filter[status], filter[source] and the documented date/range filters; cursor-based pagination.

get/companies/{company}/purchase-scans

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/purchase-scans
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

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

Query parameters

limitinteger

Number of objects to return, between 1 and 100 (default 25).

starting_afterstring uuid nullable

Cursor for forward pagination: pass the id of the last object on the previous page (the next_cursor of the previous response).

ending_beforestring uuid nullable

Cursor for backward pagination: the id of the first scan of the page you hold. It cannot be combined with starting_after.

searchstring

Free-text search (partial, case-insensitive match).

sort'received_at' | '-received_at' | 'issue_date' | '-issue_date' | 'total' | '-total' | 'status' | '-status'

Sort order: received_at (default is -received_at, newest first), issue_date, total or status; prefix it with - for descending.

filter[status]'received' | 'queued' | 'processing' | 'needs_review' | 'duplicate' | 'failed' | 'auto_created' | 'created' | 'archived'

Only scans in this status: received, queued, processing, needs_review, duplicate, failed, auto_created, created or archived.

filter[has_issues]boolean

true returns only scans that have issues to review and false only those without any.

filter[sender]string

Sender of the scan: a full email address or a domain that starts with @ (up to 254 characters).

filter[source]string

Comma-separated list of scan sources. Allowed values: upload, email, api.

Comma-separated list of scan sources: upload, email or api.

filter[document_kind]string

Comma-separated list of document kinds. Allowed values: invoice, simplified_qualified, ticket, delivery_note, other, undetermined.

Comma-separated list of document kinds: invoice, simplified_qualified, ticket, delivery_note, other or undetermined.

filter[file_kind]string

Comma-separated list of file kinds. Allowed values: pdf, image.

Comma-separated list of file kinds: pdf or image.

filter[supplier_link_state]string

Comma-separated list of supplier link states. Allowed values: linked, pending_link, unidentified.

Comma-separated list of supplier link states: linked, pending_link or unidentified.

filter[supplier_id]string uuid

Comma-separated list of supplier ids (up to 20).

Comma-separated list of supplier identifiers (UUID v7, up to 20).

filter[created][eq]string date

Only scans created on this date (YYYY-MM-DD).

filter[created][gt]string date

Only scans created after this date (YYYY-MM-DD).

filter[created][gte]string date

Only scans created on or after this date (YYYY-MM-DD).

filter[created][lt]string date

Only scans created before this date (YYYY-MM-DD).

filter[created][lte]string date

Only scans created on or before this date (YYYY-MM-DD).

filter[issued_on][eq]string date

Only scans whose document was issued on this date (YYYY-MM-DD).

filter[issued_on][gt]string date

Only scans whose document was issued after this date (YYYY-MM-DD).

filter[issued_on][gte]string date

Only scans whose document was issued on or after this date (YYYY-MM-DD).

filter[issued_on][lt]string date

Only scans whose document was issued before this date (YYYY-MM-DD).

filter[issued_on][lte]string date

Only scans whose document was issued on or before this date (YYYY-MM-DD).

filter[total][eq]string

Only scans whose total equals this amount (decimal string, up to 4 decimals).

filter[total][gt]string

Only scans whose total is greater than this amount (decimal string, up to 4 decimals).

filter[total][gte]string

Only scans whose total is at least this amount (decimal string, up to 4 decimals).

filter[total][lt]string

Only scans whose total is less than this amount (decimal string, up to 4 decimals).

filter[total][lte]string

Only scans whose total is at most this amount (decimal string, up to 4 decimals).

Headers

Factuarea-Versionstring date
Example:2026-06-01

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.

Response

Successful scanner operation.

has_moreboolean required
next_cursorstring uuid nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.