---
title: "Scan receipt image"
method: POST
path: "/transactions/scan-receipt"
tags: ["transactions"]
---

# Scan receipt image

`POST /transactions/scan-receipt`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/transactions/scan-receipt`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Scans a receipt image and extracts bill items and totals

## Response `200`

Receipt scanned successfully

- object
  - `data` ReceiptScanResponseDto
    - `items` ReceiptScanItemDto[], required
      - `id` string, required: Bill item ID
      - `name` string, required: Extracted bill item name
      - `amount` number, required: Extracted bill item amount
      - `quantity` number, required: Extracted quantity
      - `assignedTo` string[], required: Assigned members list
    - `total` number: Detected total amount
    - `subtotal` number: Detected subtotal amount
    - `tax` number: Detected tax amount
    - `tip` number: Detected tip amount
    - `vendor` string: Detected vendor name
    - `date` string: Detected transaction date (ISO date or text)
    - `confidence` number, required: Overall OCR confidence from 0 to 100
    - `rawText` string, required: Raw extracted text
    - `detectedLanguage` 'eng' | 'spa' | 'eng+spa': Detected language
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/spliteo/apis/spliteo-api.md) · [All operations](https://skmtc.dev/spliteo/apis/spliteo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spliteo/apis/spliteo-api/revisions/bd9b84f4e407?raw)