Yomio REST API

Explore Yomio routes, authorize with your account, and scan documents.

The OpenAPI reference lists current client routes, including routes kept for older app versions.

Sign in to try requests

In Swagger UI, select Authorize and sign in to Yomio in the browser. Swagger then sends your access token with each authenticated request.

For scripts, send a Yomio access token as a Bearer token. Swagger keeps its authorization only for the current browser session. Requests use your Yomio account and its normal scan quota. Separate developer API keys are not available.

Scan a receipt

Send a multipart request to POST /api/v3/documents. Use the field name document for the file. The endpoint returns a document ID with a processing status.

curl --request POST \
  --url https://api.yomio.app/api/v3/documents \
  --header "Authorization: Bearer $YOMIO_ACCESS_TOKEN" \
  --form "document=@receipt.jpg" \
  --form "documentType=receipt" \
  --form "transactionType=EXPENSE"

The server responds with HTTP 202 Accepted and a document.id. Poll the status route until processing finishes.

curl --url https://api.yomio.app/api/v3/documents/DOCUMENT_ID/status \
  --header "Authorization: Bearer $YOMIO_ACCESS_TOKEN"

Upload options

  • documentType accepts receipt, invoice, or other.
  • transactionType accepts EXPENSE or INCOME.
  • timezone accepts a time zone name such as Europe/Berlin.
  • pipeline accepts v1 or v2. The default is v1.
  • Files must be 10 MiB or smaller. PDF page count follows the API configuration.

Invoice and other document scans use the same authenticated account and quota rules as receipt scans. The status response includes the resulting expense when processing completes and one is created.

Route reference

Use Swagger UI to inspect request fields, responses, auth requirements, and compatibility routes. New integrations should use the v3 scan route instead of the legacy synchronous document routes.