Paystub Extractor SDK - Earning Statement Extractor solution to automatically extract fields from paystub - ByteScout
Announcement
Our ByteScout SDK products are sunsetting as we focus on expanding new solutions.
Learn More Open modal
Close modal
Announcement Important Update
ByteScout SDK Sunsetting Notice
Our ByteScout SDK products are sunsetting as we focus on our new & improved solutions. Thank you for being part of our journey, and we look forward to supporting you in this next chapter!

Paystub Extractor SDK – Earning Statement Extractor solution to automatically extract fields from paystub

  • Home
  • /
  • Paystub Extractor SDK – Earning Statement Extractor solution to automatically extract fields from paystub

ByteScout Paystub Extractor (also known as “Earnings Statement Extractor”) is the set of automated tools that can take unstructured electronic PDF paystubs, scanned paystubs, and automatically extract data from them as JSON or CSV data file.

Features

  • Automatically parses PDF files with earning statements;
  • No templates and no additional coding are required;
  • Extracts from unstructured paystubs into CSV and JSON;
  • Automatically detects and extracts the following fields from paystubs:
    • Employee Name and Pay/Check Date
    • Pay Period End and Date
    • Deposit Amount
    • Current Net Pay, Current Gross Pay
    • Employer Name
    • Bank Account Number, Bank Location, Bank Number, Bank Transit ABA
    • YTD Net pay and YTD Gross Pay

DEMO 1: Earnings statements auto-extractor form PDF Paystub sample 1

Input PDF

screenshot of the source paystub pdf

Output JSON

scroll the code to see full JSON

[
  {
    "fieldType": "Employer_Name",
    "fieldValue": "Company Ltd",
    "fieldConfidence": 0.71400000000000008,
    "x": 138.7,
    "y": 273.0,
    "width": 66.29000000000002,
    "height": 12.0
  },
  {
    "fieldType": "Pay_Period_End",
    "fieldValue": "01/29/2001",
    "fieldConfidence": 0.85636363636363644,
    "x": 193.9,
    "y": 56.8,
    "width": 56.989999999999995,
    "height": 12.0
  },
  {
    "fieldType": "Pay_Or_Check_Date",
    "fieldValue": "01/30/2001",
    "fieldConfidence": 0.93,
    "x": 207.7,
    "y": 56.8,
    "width": 46.989999999999995,
    "height": 12.0
  },
  {
    "fieldType": "Employee_Name",
    "fieldValue": "Jane Doe",
    "fieldConfidence": 0.7695,
    "x": 235.3,
    "y": 56.8,
    "width": 44.3,
    "height": 12.0
  },
  {
    "fieldType": "Current_Gross_Pay",
    "fieldValue": "2,040.00",
    "fieldConfidence": 0.93,
    "x": 331.9,
    "y": 358.7,
    "width": 42.0,
    "height": 12.0
  },
  {
    "fieldType": "YTD_Gross_Pay",
    "fieldValue": "4,080.00",
    "fieldConfidence": 0.93,
    "x": 331.9,
    "y": 458.4,
    "width": 42.0,
    "height": 12.0
  },
  {
    "fieldType": "Current_Net_Pay",
    "fieldValue": "1,785.00",
    "fieldConfidence": 0.93,
    "x": 447.7,
    "y": 59.6,
    "width": 40.279999999999994,
    "height": 12.0
  },
  {
    "fieldType": "YTD_Net_Pay",
    "fieldValue": "3,570.00",
    "fieldConfidence": 0.93,
    "x": 447.7,
    "y": 458.4,
    "width": 42.0,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Location",
    "fieldValue": "012345678",
    "fieldConfidence": 0.93,
    "x": 508.4,
    "y": 184.2,
    "width": 75.62,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Location_Second",
    "fieldValue": "",
    "fieldConfidence": 0.93,
    "x": -1.0,
    "y": -1.0,
    "width": -1.0,
    "height": -1.0
  },
  {
    "fieldType": "Bank_Account_Number",
    "fieldValue": "9876543210",
    "fieldConfidence": 0.93,
    "x": 508.4,
    "y": 308.9,
    "width": 88.25,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Account_Number_Second",
    "fieldValue": "",
    "fieldConfidence": 0.93,
    "x": -1.0,
    "y": -1.0,
    "width": -1.0,
    "height": -1.0
  },
  {
    "fieldType": "Deposit_Amount",
    "fieldValue": "1,785.00",
    "fieldConfidence": 0.81,
    "x": 508.4,
    "y": 433.5,
    "width": 41.930000000000007,
    "height": 12.0
  },
  {
    "fieldType": "Deposit_Amount_Second",
    "fieldValue": "",
    "fieldConfidence": 0.81,
    "x": -1.0,
    "y": -1.0,
    "width": -1.0,
    "height": -1.0
  }
]

DEMO 2: Earnings Statement Auto-Extraction from PDF paystub

Input PDF

screenshot of the sample paystub 2

Generated JSON

scroll the code to see full JSON
[
  {
    "fieldType": "Pay_Or_Check_Date",
    "fieldValue": "02/01/2010",
    "fieldConfidence": 0.93,
    "x": 187.8,
    "y": 272.2,
    "width": 47.629999999999995,
    "height": 12.0
  },
  {
    "fieldType": "Employer_Name",
    "fieldValue": "Company Ltd",
    "fieldConfidence": 0.71400000000000008,
    "x": 224.1,
    "y": 56.8,
    "width": 67.79,
    "height": 12.0
  },
  {
    "fieldType": "Employee_Name",
    "fieldValue": "John Doe",
    "fieldConfidence": 0.7695,
    "x": 115.1,
    "y": 388.6,
    "width": 46.100000000000023,
    "height": 12.0
  },
  {
    "fieldType": "Pay_Period_End",
    "fieldValue": "01/30/2010",
    "fieldConfidence": 0.85636363636363644,
    "x": 187.8,
    "y": 388.6,
    "width": 57.720000000000027,
    "height": 12.0
  },
  {
    "fieldType": "Current_Gross_Pay",
    "fieldValue": "2,860.00",
    "fieldConfidence": 0.93,
    "x": 389.5,
    "y": 59.6,
    "width": 30.699999999999996,
    "height": 26.0
  },
  {
    "fieldType": "YTD_Gross_Pay",
    "fieldValue": "5,515.00",
    "fieldConfidence": 0.93,
    "x": 389.5,
    "y": 59.6,
    "width": 30.699999999999996,
    "height": 26.0
  },
  {
    "fieldType": "Current_Net_Pay",
    "fieldValue": "2,110.00",
    "fieldConfidence": 0.93,
    "x": 423.1,
    "y": 332.0,
    "width": 40.94,
    "height": 12.0
  },
  {
    "fieldType": "YTD_Net_Pay",
    "fieldValue": "4,015.00",
    "fieldConfidence": 0.93,
    "x": 423.1,
    "y": 332.0,
    "width": 40.94,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Account_Number",
    "fieldValue": "000111222333",
    "fieldConfidence": 0.93,
    "x": 569.1,
    "y": 258.9,
    "width": 50.269999999999982,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Account_Number_Second",
    "fieldValue": "333222111000",
    "fieldConfidence": 0.93,
    "x": 569.1,
    "y": 258.9,
    "width": 50.269999999999982,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Transit_ABA",
    "fieldValue": "00001234",
    "fieldConfidence": 0.93,
    "x": 569.1,
    "y": 358.7,
    "width": 58.629999999999995,
    "height": 12.0
  },
  {
    "fieldType": "Bank_Transit_ABA_Second",
    "fieldValue": "12340000",
    "fieldConfidence": 0.93,
    "x": 569.1,
    "y": 358.7,
    "width": 58.629999999999995,
    "height": 12.0
  },
  {
    "fieldType": "Deposit_Amount",
    "fieldValue": "450.00",
    "fieldConfidence": 0.81,
    "x": 569.1,
    "y": 458.4,
    "width": 39.45999999999998,
    "height": 12.0
  },
  {
    "fieldType": "Deposit_Amount_Second",
    "fieldValue": "1,660.00",
    "fieldConfidence": 0.81,
    "x": 569.1,
    "y": 458.4,
    "width": 39.45999999999998,
    "height": 12.0
  }
]