Skip to main content
POST
Search pay stubs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
payroll_id
string
required

The payroll whose pay stubs to search.

pay_stubs
object
required

The selection criteria.

pay_stubs.include must be either the string "all", or an object containing one or more of ids (string array), work_assignment_ids (string array - selects the stubs for those work assignments), payee_type (employee or contractor).

pay_stubs.exclude (optional) is an object containing one or more of the same keys.

Response

200 - application/json

OK

object
string
read-only

The type of the object in Nmbr ("list").

data
object[]