API Documentation
Documents
Document Conversion
Personal Earnings Statement
Certificate Of Origin
Dangerous Goods Declaration
International Consignment Note
Utility Bill
Get Utility Bill Fields
This endpoint returns an object representing the extracted utility-bill model fields from a document.
GET
/
v1-preview
/
models
/
utility-bill
/
{documentId}
using ABBYY.DocumentAI;
using ABBYY.DocumentAI.Schemas.Components;
var sdk = new DocumentAI(apiKeyAuth: "<YOUR_BEARER_TOKEN_HERE>");
var res = await sdk.Models.UtilityBill.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "utility-bill",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"billingPeriod": {
"startDate": "2024-02-01",
"endDate": "2024-02-29"
},
"billDate": "2024-03-01",
"billNumber": "INV-2024-001",
"issuer": {
"name": "Power & Light Company",
"address": "123 Energy Street",
"taxId": "TAX123456"
},
"customer": {
"accountNumber": "ACC987654",
"name": "John Smith",
"customerAddress": "456 Customer Ave",
"serviceAddress": "789 Service Blvd",
"taxId": "CUST123456"
},
"remitTo": {
"name": "Power & Light Billing",
"address": "321 Billing Street"
},
"amountDue": 150,
"currentCharges": 145,
"currency": "USD",
"lineItems": [
{
"billingNumber": "ACC987654",
"description": "Electricity Usage",
"quantity": 500,
"unitPrice": 0.25,
"uom": "kWh",
"amount": 125
},
{
"billingNumber": "ACC987654",
"description": "Service Fee",
"quantity": 1,
"unitPrice": 20,
"uom": "EA",
"amount": 20
}
],
"previousBalance": 0,
"lastPayment": -150,
"balanceForward": 0,
"dueDate": "2024-03-15",
"amountAfterDueDate": 155,
"lateCharge": 5,
"penalties": 0,
"adjustments": [
{
"adjustments": -150
}
]
}
}
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 Utility Bill 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.UtilityBill.GetExtractedFieldsAsync(documentId: "wh23anb5xjf0ntw5taase5qz");
// handle response
{
"meta": {
"id": "wh23anb5xjf0ntw5taase5qz",
"name": "document.jpg",
"createdAt": "2025-02-07T17:44:06.949Z",
"model": "utility-bill",
"status": "Processed",
"pageCount": 10,
"errors": [
{
"message": "Total is required"
}
]
},
"fields": {
"billingPeriod": {
"startDate": "2024-02-01",
"endDate": "2024-02-29"
},
"billDate": "2024-03-01",
"billNumber": "INV-2024-001",
"issuer": {
"name": "Power & Light Company",
"address": "123 Energy Street",
"taxId": "TAX123456"
},
"customer": {
"accountNumber": "ACC987654",
"name": "John Smith",
"customerAddress": "456 Customer Ave",
"serviceAddress": "789 Service Blvd",
"taxId": "CUST123456"
},
"remitTo": {
"name": "Power & Light Billing",
"address": "321 Billing Street"
},
"amountDue": 150,
"currentCharges": 145,
"currency": "USD",
"lineItems": [
{
"billingNumber": "ACC987654",
"description": "Electricity Usage",
"quantity": 500,
"unitPrice": 0.25,
"uom": "kWh",
"amount": 125
},
{
"billingNumber": "ACC987654",
"description": "Service Fee",
"quantity": 1,
"unitPrice": 20,
"uom": "EA",
"amount": 20
}
],
"previousBalance": 0,
"lastPayment": -150,
"balanceForward": 0,
"dueDate": "2024-03-15",
"amountAfterDueDate": 155,
"lateCharge": 5,
"penalties": 0,
"adjustments": [
{
"adjustments": -150
}
]
}
}
Assistant
Responses are generated using AI and may contain mistakes.