Paystubs

{
  "id": "0187dc99-63be-bc96-51bf-af6b51d43687",
  "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
  "payroll_document": "0186eb89-2e52-b3c5-ac6d-05e7debb2aff",
  "deduction_list": [
    {
      "amount": "38.10",
      "name": "401K",
      "tax_classification": "pre_tax",
      "amount_ytd": "139.70"
    },
    {
      "amount": "25.40",
      "name": "Garnishment",
      "tax_classification": "post_tax",
      "amount_ytd": "76.20"
    },
    {
      "amount": "25.40",
      "name": "Garnishment",
      "tax_classification": "post_tax",
      "amount_ytd": "101.60"
    }
  ],
  "filing_status": [
    {
      "type": "federal",
      "location": null,
      "status": "married filing separately"
    },
    {
      "type": "state",
      "location": "NY",
      "status": "married filing separately"
    }
  ],
  "tax_list": [
    {
      "amount": "88.91",
      "name": "Federal Withholding",
      "type": "federal",
      "amount_ytd": "850.99"
    },
    {
      "amount": "139.72",
      "name": "Social Security Tax",
      "type": "fica",
      "amount_ytd": "381.04"
    }
  ],
  "status": "completed",
  "paystub_date": "2023-03-12T00:00:00Z",
  "paystub_period": {
    "start_date": "2023-02-28T00:00:00Z",
    "end_date": "2023-03-07T00:00:00Z"
  },
  "currency": "USD",
  "gross_pay": "1607.63",
  "deductions": "88.90",
  "taxes": "228.63",
  "net_pay": "1290.10",
  "reimbursements": "0.00",
  "hours": "49.60",
  "fees": null,
  "net_pay_ytd": "12714.18",
  "gross_pay_ytd": "15730.10",
  "employer": "Whole Goods",
  "employment": "0186a27d-e5c6-735a-a359-6315b34d544c",
  "employer_address": {
    "city": "New York",
    "line1": "852 North W St",
    "line2": "Apt 221",
    "state": "NY",
    "country": "US",
    "postal_code": "10014"
  },
  "created_at": "2023-03-13T19:53:57.122Z",
  "updated_at": "2023-03-13T19:53:57.122Z",
  "destinations": [
    {
      "reference": "CHECKING *********2201",
      "amount": "1290.10",
      "method": "direct deposit",
      "ach_deposit_account": {
        "bank_name": "NW Regional",
        "routing_number": null,
        "account_number": "*********2201"
      },
      "card": null
    }
  ],
  "hours_ytd": "422.00",
  "deductions_ytd": "533.40",
  "taxes_ytd": "2502.17",
  "gross_pay_list": [
    {
      "name": "Regular",
      "type": "base",
      "start_date": "2023-02-28",
      "end_date": "2023-03-07",
      "rate": "25.6088",
      "hours": "49.5977",
      "amount": "1270.14",
      "hours_ytd": "422.0000",
      "amount_ytd": "13971.54"
    },
    {
      "name": "Commission",
      "type": "commission",
      "start_date": "2023-03-04",
      "end_date": "2023-03-04",
      "rate": null,
      "hours": null,
      "amount": "337.49",
      "hours_ytd": null,
      "amount_ytd": "1758.56"
    }
  ],
  "gross_pay_list_totals": {
    "base": {
      "amount": "1270.14",
      "amount_ytd": "13971.54",
      "hours": "49.5977",
      "hours_ytd": "422.0000",
      "rate_implied": "25.6100",
      "rate_implied_ytd": "33.1100"
    },
    "overtime": null,
    "commission": {
      "amount": "337.49",
      "amount_ytd": "1758.56",
      "hours": null,
      "hours_ytd": null,
      "rate_implied": null,
      "rate_implied_ytd": null
    },
    "bonus": null,
    "other": null
  },
  "metadata": null
}

The paystub object

string<uuid>

Unique ID of the paystub object.

account

string<uuid>

ID of the account associated with the paystub.

payroll_document

string<uuid>

ID of the payroll document object associated with this paystub.

deduction_list

object[]

An itemized list of deductions listed on the paystub. Each object corresponds to one line item.

Show child attributes

filing_status

object[]

Information on the user's filing status.

Show child attributes

tax_list

object[]

An itemized list of tax withholdings listed on the paystub. Each object corresponds to one line item.

Show child attributes

status

enum<string>

Payment status of the paystub.

completed - Payment has been made to the user.
scheduled - Payment is scheduled to be made to the user.
cancelled - Payment was cancelled, and was not nor will be paid to the user.
excluded - Tag used for dummy/sample/watermarked/test paystubs present in the account. These paystubs are excluded when generating reports and other calculations and should not be considered proof of income.

Available options:

completed,

scheduled,

cancelled,

excluded

paystub_date

string<date-time>

Timestamp (ISO 8601) of the payment date, sourced from the paystub.

paystub_period

object

Start date and end date of the work period.

Show child attributes

currency

string

Currency code (ISO 4217).

gross_pay

string

Total gross pay from the paystub period before taxes or deductions. Returned as a decimal string with exactly two decimal places.

deductions

string

Total amount of deductions from the paystub period. Returned as a decimal string with exactly two decimal places.

taxes

string

Total tax amount from the paystub period. Returned as a decimal string with exactly two decimal places.

net_pay

string

Net pay (gross pay minus taxes and deductions) from the paystub period. Returned as a decimal string with exactly two decimal places.

reimbursements

string

Total reimbursement amount from the paystub period. Returned as a decimal string with exactly two decimal places.

hours

string

Total hours worked during the paystub period. Returned as a decimal string with exactly two decimal places.

fees

string

Total fees incurred during the paystub period. Returned as a decimal string with exactly two decimal places.

net_pay_ytd

string

Net pay year-to-date, including this paystub. Returned as a decimal string with exactly two decimal places.

gross_pay_ytd

string

Gross pay year-to-date, including this paystub. Returned as a decimal string with exactly two decimal places.

employer

string

Employer name.

employment

string

Employment ID. Can be used as a filter when listing paystubs.

employer_address

object

Object containing employer address information, sourced from the paystub.

Show child attributes

created_at

string<date-time>

Timestamp (ISO 8601) when the paystub object was created.

updated_at

string<date-time>

Timestamp (ISO 8601) when a property value of the paystub object most recently changed.

destinations

object[]

Contains information on where and how pay was delivered to the user.

Show child attributes

hours_ytd

string

Total hours worked year-to-date, including this paystub's work period. Returned as a decimal string with exactly two decimal places.

deductions_ytd

string

Total deductions year-to-date, including amounts from this paystub. Returned as a decimal string with exactly two decimal places.

taxes_ytd

string

Total taxes year-to-date, including amounts from this paystub. Returned as a decimal string with exactly two decimal places.

gross_pay_list

object[]

An itemized list of gross pay listed on the paystub. Each object corresponds to one line item.

Show child attributes

gross_pay_list_totals

object

Sums the values of gross_pay_list objects based on their type:

base = base + pto
overtime = overtime
commission = commission
bonus = bonus
other = disability + benefits + tips + stock + other

Show child attributes

metadata

object

Additional, non-categorized information.

List All Identities Retrieve A Paystub

⌘I

Core Resources

Coverage

Payroll Data Sets

Banking

Reports

Workflows

Verifications

Partners Verifications

Webhooks

Receipts

Error Codes

The paystub object

​The paystub object

The paystub object