Pay stub
{
| Attribute | Data Type | Description |
|---|---|---|
uuid | UUID | ID for the Pay stub |
book_uuid | UUID | ID for the Book containing the Pay stub |
doc_uuid | UUID | ID for the Document containing the Pay stub |
doc_page_numbers | List of Integers | |
employer | Employer | |
employee | Employee | |
employment_details | Employment Details | |
paystub_details | Pay stub 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
{
}
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 |
}
Net Pay
{
| Attribute | Data Type | Description |
|---|---|---|
distribution_details | List of Pay Distributions | |
totals | Total |
}
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
{
}
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 TaxNULL 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 TaxNULL 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
{
}
Updated 5 months ago