Skip to main content
GET
getPayPeriod

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
method
string
required
companyId
string<uuid>
required
workerType
enum<string>
required
Available options:
W2,
1099-NEC

Response

payPeriodId
string
required
payPeriod
string
required
payBeginDate
string
required
payEndDate
string
required
payDate
string
required
deadLineToRunPayroll
string
required
payPeriodStatus
enum<string>
required
Available options:
new,
submitted,
cancelled,
inProcess,
processed,
failed,
returned,
skipped
payrollAmount
number
required