Ocrolus API

Ocrolus API Documentation

Welcome to the Ocrolus API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

Payroll Report

Entities applying for PPP are required to submit proof of payroll for the previous year (2019). In addition to the IRS forms Payroll reports are also required as part of the PPP. These payroll documents likely include:

  • Summary report for the 12 months ending 2019 from applying entity
  • Per employee report detailing gross pay for the 12 months ending 2019 from applying entity
  • Report detailing other payroll information such as group health benefits, retirement benefits, state taxes and local taxes from the applying entity

All this information can be found through an applying entity's payroll provider.

The form_type parameter `PAYROLL_SUMMARY for the Upload PDF endpoint is required for this Form Type.

Optional fields captured

📘

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON Attribute

Data Type

Description

payroll_summary-Part1-General:companyName

Text

The name of the applying entity

payroll_summary-Part1-General:ein

Text

The employer EIN

payroll_summary-Part1-General:beginningDate

Date

The beginning date covered by the payroll report

payroll_summary-Part1-General:endingDate

Date

The ending date covered by the payroll report

payroll_summary-Part1-General:numberOfJobs

Text

Current number of jobs filled by employer

payroll_summary-Part2-CompanyTotal:grossPay-Total

Money

Amount in gross pay

payroll_summary-Part2-CompanyTotal:grossPayInExcessOf$100K-Total

Money

Amount in gross pay above 100,000 USD

payroll_summary-Part2-CompanyTotal:sbaGrossPay-Total

Money

Amount in gross pay as per SBA guidelines

payroll_summary-Part2-CompanyTotal:employerTaxesStateAndLocal-Total

Money

Amount employer paid in state and local taxes

payroll_summary-Part2-CompanyTotal:employerBenefitCost-Total

Money

Amount employer contributed in benefits to employees

payroll_summary-Part2-CompanyTotal:retirementContributions-Total

Money

Amount employer contributed in retirement to employees if explicitly called out

payroll_summary-Part2-CompanyTotal:payrollCost-Total

Money

Total payroll cost considering the caps dictated by SBA

payroll_summary-Part2-CompanyTotal:payrollCost-MonthlyAverage

Money

Average payroll cost for employer

payroll_summary-Part2-CompanyTotal:numberOfEmployeesPaid-MonthlyAverage

Text

Average number of employees employed

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Sample JSON Result

{
  "form_type": "PAYROLL_SUMMARY",
  "pk": 4631822,
  "form_config_pk": 1628,
  "raw_fields": {
    "payroll_summary-Part1-General:companyName": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047624,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "OCROLUS INC."
    },
    "payroll_summary-Part1-General:ein": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047624,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "12-3456789"
    },
    "payroll_summary-Part1-General:beginningDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047624,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "01/01/2019"
    },
    "payroll_summary-Part1-General:endingDate": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047624,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "12/31/2019"
    },
    "payroll_summary-Part1-General:numberOfJobs": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047624,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "2"
    },
    "payroll_summary-Part2-CompanyTotal:grossPay-Total": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "600000.00"
    },
    "payroll_summary-Part2-CompanyTotal:grossPayInExcessOf$100K-Total": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "400000.00"
    },
    "payroll_summary-Part2-CompanyTotal:sbaGrossPay-Total": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "200000.00"
    },
    "payroll_summary-Part2-CompanyTotal:employerTaxesStateAndLocal-Total": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "24000.00"
    },
    "payroll_summary-Part2-CompanyTotal:employerBenefitCost-Total": {
      "alias_used": "Employer Benefit (Retire+Health) Cost Total",
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "36000.00"
    },
    "payroll_summary-Part2-CompanyTotal:retirementContributions-Total": {
      "alias_used": null,
      "is_empty": true,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": ""
    },
    "payroll_summary-Part2-CompanyTotal:payrollCost-Total": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "260000.00"
    },
    "payroll_summary-Part2-CompanyTotal:payrollCost-MonthlyAverage": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "21665.67"
    },
    "payroll_summary-Part2-CompanyTotal:numberOfEmployeesPaid-MonthlyAverage": {
      "alias_used": null,
      "is_empty": false,
      "page_doc_pk": 64047625,
      "source_filename": "Ocrolus Sample PDF - Payroll Report Employee Detail.pdf",
      "value": "2"
    }
  },
  "tables": []
}

Updated 4 months ago

Payroll Report


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.