Upload Supplier Invoice PDF

POST 
/api/purchase-invoices/ocr/upload

Upload a supplier invoice PDF to start the OCR extraction. Requires Invoice OCR to be enabled in Settings → Invoice OCR (returns 422 if not enabled).

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Response 201:

{
  "data": {
    "extraction_id": 7,
    "tracked_job_log_id": 1234,
    "status": "processing"
  },
  "message": "OCR processing started"
}

Poll GET /purchase-invoices/ocr/{id} until status is 'pending_review' (or 'failed' / 'duplicate_detected').

Request

Responses

200

Successful response

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.