Get Payroll Run By Id
Returns a PayrollRun object with the given id.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Path Parameters
Query Parameters
Whether to include the original data Bindbee fetched from the third-party to produce these models.
Whether to include custom fields in the response.
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.
Response
The PayrollRun object is used to represent a group of pay statements for a specific pay schedule.
The day and time the payroll run was checked.
The custom fields related to the model
The day and time the payroll run ended.
This is the datetime that this object was last updated by Bindbee
The paygroup to which this pay cycle belongs to
The payroll run calendar to which which the payroll run belongs
The third-party API ID of the matching object.
The state of the payroll run Possible values include: PAID, DRAFT, APPROVED, FAILED, CLOSED. In cases where there is no clear mapping, the original value passed through will be returned.
The type of the payroll run Possible values include: REGULAR, OFF_CYCLE, CORRECTION, TERMINATION, SIGN_ON_BONUS. In cases where there is no clear mapping, the original value passed through will be returned.
The day and time the payroll run started.
This is the Raw data