Hotel Invoice
Get Hotel Invoice Fields
This endpoint returns an object representing the extracted hotel-invoice model fields from a document.
GET
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 Hotel Invoice Data Response
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 extracted from a hotel invoice
Example:
{
"date": "2024-03-15",
"checkInDate": "2024-03-10",
"checkOutDate": "2024-03-15",
"nights": 5,
"hotelName": "Grand Hotel",
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"postalCode": "10001",
"country": "USA",
"phone": "+1-123-456-7890",
"currency": "USD",
"total": 1250,
"taxTotal": 125,
"taxes": [{ "taxRate": 10, "taxAmount": 125 }],
"paymentMethod": "Card",
"cardType": "VISA",
"creditOrDebit": "Credit",
"cardNumber": "XXXX-XXXX-XXXX-1234",
"lineItems": [
{
"sku": "ROOM-101",
"description": "Deluxe Room",
"quantity": 5,
"price": 200,
"amount": 1000
},
{
"sku": "PARK-001",
"description": "Parking",
"quantity": 5,
"price": 50,
"amount": 250
}
]
}
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?