API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Receipt
Get Receipt Fields
This endpoint returns an object representing the extracted receipt model fields from a document.
GET
/
v1-preview
/
models
/
receipt
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.Receipt.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "receipt",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"vendor": "Abbyy",
"address": "123 Main St\nAnytown, USA 12345",
"city": "Anytown",
"country": "USA",
"date": "2021-01-01",
"currency": "USD",
"total": 100,
"phone": "123-456-7890",
"paymentMethod": "Card",
"cardType": "Visa",
"cardNumber": "1234567890123456",
"tip": 0,
"taxTotal": 10,
"taxes": [
{
"taxAmount": 10,
"taxRate": 10
}
],
"lineItems": [
{
"amount": 100,
"price": 100,
"description": "Item 1",
"quantity": 1,
"sku": "1234567890"
}
],
"expenseType": {
"airfare": false,
"carParking": false,
"carRental": false,
"gasolineStation": false,
"generalRetail": true,
"hotel": false,
"other": false,
"restaurant": false,
"taxi": false,
"tollRoad": false,
"transport": false
}
}
}
Authorizations
Our API offers authentication via API keys. You can obtain an API key from https://developer.abbyy.com
Path Parameters
The id of the document
Response
200
application/json
Extracted Receipt Data Response
Was this page helpful?
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.Receipt.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "receipt",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"vendor": "Abbyy",
"address": "123 Main St\nAnytown, USA 12345",
"city": "Anytown",
"country": "USA",
"date": "2021-01-01",
"currency": "USD",
"total": 100,
"phone": "123-456-7890",
"paymentMethod": "Card",
"cardType": "Visa",
"cardNumber": "1234567890123456",
"tip": 0,
"taxTotal": 10,
"taxes": [
{
"taxAmount": 10,
"taxRate": 10
}
],
"lineItems": [
{
"amount": 100,
"price": 100,
"description": "Item 1",
"quantity": 1,
"sku": "1234567890"
}
],
"expenseType": {
"airfare": false,
"carParking": false,
"carRental": false,
"gasolineStation": false,
"generalRetail": true,
"hotel": false,
"other": false,
"restaurant": false,
"taxi": false,
"tollRoad": false,
"transport": false
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.