Skip to main content
GET
getPayPeriodDetails

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
enum<string>
required
Available options:
getPayPeriodDetails
Example:

"getPayPeriodDetails"

payPeriodId
string<uuid>
required

ID of the pay period to retrieve.

companyId
string<uuid>

Optional company ID. Resolved from payPeriodId when omitted.

includeTransactions
boolean
default:false

Include company debit and employee credit transaction details. Transaction fields are omitted when false.

limit
integer

Maximum number of payroll line items to return. Use a positive value for a bounded page; omit for no page-size limit.

Required range: x >= 0
offset
integer
default:0

Number of payroll line items to skip. Supplying limit or offset adds root-level pagination metadata.

Required range: x >= 0

Response

200 - application/json

Pay period details. Pagination and transaction fields are included only when requested.

payPeriod
object[]
required
pagination
object

Present when limit or offset is supplied. total counts payroll line items for the pay period, not just the returned page.

companyPayrollTransactions
object[]

Company debit and credit transactions for the pay period. Present at the response root only when includeTransactions is true.