ExpenseReceipt

Expense receipt upload and OCR processing

Poll the OCR result for an uploaded receipt#

GET /api/v1/expenses/ocr/{receipt_ref}

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Receipt-OCR poll (Epic #604). The client polls the opaque receipt_ref returned by POST /api/v1/expenses/upload-receipt until the capture is terminal. Scope expenses:read / permission expenses.view. Org-scoped: captures never cross organizations; an unknown or cross-org receipt_ref returns 404. Extracted fields keys equal StoreExpenseRequest exactly; amounts are decimal strings, dates Y-m-d, currency ISO-4217. Provider is self-hosted (EU residency); orphan captures are purged after the retention window (default 30 days).

Paramètres#

Réponses#

Exemple de requête#

curl -X GET "https://app.encryptinvoice.com/api/v1/expenses/ocr/{receipt_ref}" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"

Upload a receipt for asynchronous OCR extraction#

POST /api/v1/expenses/upload-receipt

Nécessite une authentification (jeton Bearer) et l’en-tête X-Organization-Id.

Receipt-OCR upload (Epic #604, task #607). Stores the receipt on the organization's S3 disk under expenses/receipts/{uuid}.ext, creates a staging capture and enqueues an async OCR job on the ocr queue. Returns 202 with an opaque receipt_ref the client then polls via GET /api/v1/expenses/ocr/{receipt_ref}.

Scope expenses:write / permission expenses.create. Org-scoped — captures never cross organizations.

Idempotency: supply an Idempotency-Key header. A repeated key (same org) returns the same capture with no new storage write and no new job.

Optional expense_id enables post-create mode: OCR enriches that existing expense in place instead of creating a capture-driven expense. The expense_id must belong to the caller's organization.

The extracted fields keys equal StoreExpenseRequest exactly; amounts are decimal strings, dates Y-m-d, currency ISO-4217. Provider is self-hosted (PaddleOCR-VL + local LLM, EU residency, no external AI calls). Orphan captures (never promoted to an expense) are purged after the retention window (default 30 days). No receipt bytes or extracted PII are logged.

Note: an unsupported media type is rejected as 422 (via the mimes validation rule), not 415. An over-size file is 413 when it exceeds the organization storage byte-quota, otherwise 422 (the file max:10240 rule).

Paramètres#

Réponses#

Exemple de requête#

curl -X POST "https://app.encryptinvoice.com/api/v1/expenses/upload-receipt" \
  -H "Authorization: Bearer {{access_token}}" \
  -H "X-Organization-Id: {{organization_id}}" \
  -H "Accept: application/json"