GET
/
v1-preview
/
models
/
personal-earnings-statement
/
{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.personal_earnings_statement.get_extracted_fields(document_id="wh23anb5xjf0ntw5taase5qz")

    assert res.personal_earnings_statement is not None

    # Handle response
    print(res.personal_earnings_statement)
{
  "meta": {
    "id": "wh23anb5xjf0ntw5taase5qz",
    "name": "document.jpg",
    "createdAt": "2025-02-07T17:44:06.949Z",
    "model": "personal-earnings-statement",
    "status": "Processed",
    "pageCount": 10,
    "errors": [
      {
        "message": "Total is required"
      }
    ]
  },
  "fields": {
    "employeeName": "John A. Smith",
    "employeeAddress": "456 Home Street, San Francisco, CA 94105",
    "employerIdentificationNumber": "12-3456789",
    "ssn": "123-45-6789",
    "employerName": "ACME Corporation",
    "employerAddress": "123 Business Ave, Suite 100, San Francisco, CA 94105",
    "reportingPeriodStartDate": "2023-12-01",
    "reportingPeriodEndDate": "2023-12-31",
    "payDate": "2024-01-15",
    "payRate": 75,
    "currentPeriodGrossPay": 3000,
    "yearToDateGrossPay": 90000,
    "currentPeriodTotalDeductions": 500,
    "currentPeriodTotalTaxes": 750,
    "currentPeriodNetPay": 1750,
    "yearToDateTotalDeductions": 15000,
    "yearToDateTotalTaxes": 22500,
    "yearToDateNetPay": 52500
  }
}

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 Personal Earnings Statement 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 personal earnings statement

Example:
{
  "employeeName": "John A. Smith",
  "employeeAddress": "456 Home Street, San Francisco, CA 94105",
  "employerIdentificationNumber": "12-3456789",
  "ssn": "123-45-6789",
  "employerName": "ACME Corporation",
  "employerAddress": "123 Business Ave, Suite 100, San Francisco, CA 94105",
  "reportingPeriodStartDate": "2023-12-01",
  "reportingPeriodEndDate": "2023-12-31",
  "payDate": "2024-01-15",
  "payRate": 75,
  "currentPeriodGrossPay": 3000,
  "yearToDateGrossPay": 90000,
  "currentPeriodTotalDeductions": 500,
  "currentPeriodTotalTaxes": 750,
  "currentPeriodNetPay": 1750,
  "yearToDateTotalDeductions": 15000,
  "yearToDateTotalTaxes": 22500,
  "yearToDateNetPay": 52500
}
​
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?