GET
/
v1-preview
/
models
/
taxi-receipt
/
{documentId}
from abbyy_document_ai import DocumentAi
import os


with DocumentAi(
    api_key_auth=os.getenv("DOCUMENTAI_API_KEY_AUTH", ""),
) as document_ai:

    res = document_ai.models.taxi_receipt.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.taxi_receipt is not None

    # Handle response
    print(res.taxi_receipt)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "taxi-receipt",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "date": "2024-03-15",
    "startDate": "2024-03-15",
    "endDate": "2024-03-15",
    "days": 1,
    "fromLocation": "JFK Airport",
    "toLocation": "Manhattan Hotel",
    "vendor": "Yellow Cab Company",
    "address": "789 Taxi Street",
    "city": "New York",
    "state": "NY",
    "postalCode": "10001",
    "country": "USA",
    "phone": "+1-123-456-7890",
    "currency": "USD",
    "total": 75,
    "taxTotal": 6,
    "taxes": [
      {
        "taxRate": 8,
        "taxAmount": 6
      }
    ],
    "paymentMethod": "Card",
    "cardType": "VISA",
    "creditOrDebit": "Credit",
    "cardNumber": "XXXX-XXXX-XXXX-1234"
  }
}

Authorizations

​
Authorization
string
header
required

Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com

Path Parameters

​
documentId
string
required

The id of the document

Response

200
application/json

Extracted Taxi Receipt Data Response

​
meta
object
required

Represents a document that has been submitted for processing.

Example:
{
  "id": "wh23anb5xjf0ntw5taase5qz",
  "name": "document.jpg",
  "createdAt": "2025-02-07T17:44:06.949Z",
  "model": "image-to-text",
  "status": "Processed",
  "pageCount": 10,
  "errors": [{ "message": "Total is required" }]
}
​
fields
object

Fields extracted from a taxi receipt

Example:
{
  "date": "2024-03-15",
  "startDate": "2024-03-15",
  "endDate": "2024-03-15",
  "days": 1,
  "fromLocation": "JFK Airport",
  "toLocation": "Manhattan Hotel",
  "vendor": "Yellow Cab Company",
  "address": "789 Taxi Street",
  "city": "New York",
  "state": "NY",
  "postalCode": "10001",
  "country": "USA",
  "phone": "+1-123-456-7890",
  "currency": "USD",
  "total": 75,
  "taxTotal": 6,
  "taxes": [{ "taxRate": 8, "taxAmount": 6 }],
  "paymentMethod": "Card",
  "cardType": "VISA",
  "creditOrDebit": "Credit",
  "cardNumber": "XXXX-XXXX-XXXX-1234"
}
​
validationErrors
object[]

An array of validation errors that occurred while processing the document. These typically do not prevent field extraction, but rather indicate issues extracting key fields.

Was this page helpful?