Doc Paystub Data

Sample Paystub

drive.google.com

Sample Result

{
  "book_uuid": "f06facd6-fcd9-44cd-ad40-dbfbfb79e47d",
  "doc_uuid": "9240dd2e-e7b4-4fee-bdc5-fb4ad9438bdb",
  "doc_page_numbers": [
    1
  ],
  "uuid": "1f0cc882-54b5-4bea-88ac-bbc23ab867e6",
  "employer": {
    "name": "COOL PAYSTUB COMPANY",
    "address": {
      "line1": "100 UNIVERSITY ST",
      "line2": null,
      "city": "OXFORD",
      "state_code": "VA",
      "postal_code": "11234"
    }
  },
  "employee": {
    "name": "LYRA BELACQUA",
    "address": {
      "line1": "121 WILLSWORLD LANE",
      "line2": null,
      "city": "OTHERWORLD",
      "state_code": "VA",
      "postal_code": "11234"
    },
    "marital_status": "MARRIED",
    "taxpayer_id": {
      "id_type": "SSN",
      "last_4_digits": "1234"
    }
  },
  "employment_details": {
    "hire_date": null,
    "annual_salary": {
      "amount": null,
      "currency": null
    }
  },
  "paystub_details": {
    "pay_period_start_date": "2018-12-01",
    "pay_period_end_date": "2018-12-15",
    "pay_date": "2018-12-18",
    "paystub_provider": null,
    "pay_frequency": null
    "pay_frequency_captured": null
  },
  "net_pay": {
    "distribution_details": [
      {
        "description": "CHECKING ACCOUNT ####1111",
        "bank_name": null,
        "account_number": "1111",
        "bank_account_type": "CHECKING",
        "current_pay": {
          "amount": "1190.32",
          "currency": "USD"
        }
      },
      {
        "description": "SAVINGS ACCOUNT ####2222",
        "bank_name": null,
        "account_number": "2222",
        "bank_account_type": "SAVINGS",
        "current_pay": {
          "amount": "70.00",
          "currency": "USD"
        }
      }
    ],
    "total": {
      "description": "TOTAL NET PAY",
      "canonical_description": "NET PAY",
      "current_pay": {
        "amount": "1260.32",
        "currency": "USD"
      },
      "ytd_pay": {
        "amount": null,
        "currency": null
      }
    }
  },
  "earnings": {
    "subtotals": [
      {
        "description": "REGULAR",
        "canonical_description": "REGULAR PAY",
        "current_pay": {
          "amount": "1917.00",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "46008.00",
          "currency": "USD"
        },
        "current_hours": "0.00",
        "current_rate": null
      },
      {
        "description": "BONUS",
        "canonical_description": "BONUS",
        "current_pay": {
          "amount": "0.00",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "18405.39",
          "currency": "USD"
        },
        "current_hours": "0.00",
        "current_rate": null
      }
    ],
    "totals": [
      {
        "description": "EARNINGS",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "1917.00",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "64413.39",
          "currency": "USD"
        },
        "current_hours": "0.00"
      }
    ]
  },
  "deductions": {
    "sub_totals": [
      {
        "description": "SOC SEC EE",
        "canonical_description": "SOCIAL SECURITY EMPLOYEE TAX",
        "current_pay": {
          "amount": "118.85",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "3993.63",
          "currency": "USD"
        }
      },
      {
        "description": "MED EE",
        "canonical_description": "EMPLOYEE MEDICARE",
        "current_pay": {
          "amount": "27.79",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "933.99",
          "currency": "USD"
        }
      },
      {
        "description": "FEDERAL WH",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "154.02",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "5461.61",
          "currency": "USD"
        }
      },
      {
        "description": "ILLINOIS WH",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "93.90",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "3126.08",
          "currency": "USD"
        }
      },
      {
        "description": "401K-LN",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "241.12",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "5792.92",
          "currency": "USD"
        }
      },
      {
        "description": "401-K",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "20.00",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "1260.00",
          "currency": "USD"
        }
      }
    ],
    "totals": [
      {
        "description": "TAXES",
        "canonical_description": "TAXES",
        "current_pay": {
          "amount": "394.56",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "13515.31",
          "currency": "USD"
        }
      },
      {
        "description": "DEDUCTIONS",
        "canonical_description": "NOT_FOUND",
        "current_pay": {
          "amount": "262.12",
          "currency": "USD"
        },
        "ytd_pay": {
          "amount": "7052.92",
          "currency": "USD"
        }
      }
    ]
  }
}

Paystub Composite Data Structure

{

Attribute	Data Type	Description
`uuid`	UUID	ID for the Paystub
`book_uuid`	UUID	ID for the Book containing the Paystub
`doc_uuid`	UUID	ID for the Document containing the Paystub
`doc_page_numbers`	List of Integers
`employer`	Employer
`employee`	Employee
`employment_details`	Employment Details
`paystub_details`	Paystub Details
`net_pay`	Net Pay
`earnings`	Earnings
`deductions`	Deductions

}

Employer

{

Attribute	Data Type	Description
`name`	Text
`address`	Address

}

Employee

{

Attribute	Data Type	Description
`name`	Text
`address`	Address
`marital_status`	Marital Status
`taxpayer_id`	Taxpayer ID

}

Employment Details

{

Attribute	Data Type	Description
`hire_date`	Date	Date on which Employee was hired
`annual_salary`	Money

}

Paystub Details

{

Attribute	Data Type	Description
`pay_period_start_date`	Date
`pay_period_end_date`	Date
`pay_date`	Date
`paystub_provider`	Text	Name of Payroll Provider that generated the Paystub, e.g. `ADP`
`pay_frequency`	Pay Frequency
`pay_frequency_captured`	`WEEKLYBI-WEEKLYSEMI-MONTHLYMONTHLYNULL`	Pay Frequency as explicitly printed on the Paystub

}

Net Pay

{

Attribute	Data Type	Description
`distribution_details`	List of Pay Distributions
`totals`	Totals

}

Pay Distribution

{

Attribute	Data Type	Description
`description`	Text
`bank_name`	Text	Bank Name
`account_number`	Text	Bank Account Number
`bank_account_type`	Bank Account Type
`current_pay`	Money

}

Earnings

{

Attribute	Data Type	Description
`sub_totals`	List of Earnings Subtotals
`totals`	List of Earnings Totals

}

Deductions

{

Attribute	Data Type	Description
`sub_totals`	List of Totals
`totals`	List of Totals

}

Total

{

Attribute	Data Type	Description
`description`	Text	Text of the line item as printed on Paystub
`canonical_description`	Text	Commonly used term to describe the line item, e.g. Social Security Employee Tax NULL value is provided when a line item is not recognized by Ocrolus. Information on canonical descriptions can be found here.
`current_pay`	Money
`ytd_pay`	Money

}

Earnings Subtotal

{

Attribute	Data Type	Description
`description`	Text	Text of the line item as printed on Paystub
`canonical_description`	Text	Commonly used term to describe the line item, e.g. Social Security Employee Tax NULL value is provided when a line item is not recognized by Ocrolus. Information on canonical descriptions can be found here.
`current_pay`	Money
`ytd_pay`	Money
`current_hours`	Text
`current_rate`	Text

}

Earnings Total

{

Attribute	Data Type	Description
`description`	Text	Text of the line item as printed on Paystub
`canonical_description`	Text	Commonly used term to describe the line item, e.g. Social Security Employee Tax NULL value is provided when a line item is not recognized by Ocrolus. Information on canonical descriptions can be found here.
`current_pay`	Money
`ytd_pay`	Money
`current_hours`	Text

}