Gross Payroll results can be automatically sent to an API Webhook endpoint
Edit your Pay Schedule and navigate to the "Integrations" tab then enter your API Webhook endpoint where gross payroll results should be sent.
{
"id": "20220701",
"object": "event",
"api_version": "0.2",
"created": "20220701-11:19",
"test_export": true,
"type": "gross_payroll.created",
"data": [
{
"payroll": {
"start": "20220601", //Start date of pay period
"end": "20220630" //End date of pay period
},
"client": {
"id": "123" //Company's id
},
"employees": [ //List of employees which where calculated in the pay period
{
"employee": {
"id": "4" //Employee's id
},
"wage_types": [ //List of Wage Types which are true in this pay period for the employee in this object
{
"wage_type": {
"id": "123", //Wage Type's id
"quantity": 1, //Calculated wage type quantity
"value": 60.5, //Calculated or taken wage type value
"amount": 60.5, //Wage type's amount (quantity * value)
"recalculation_month": "" //Information if month was re-calculated (German: Aufrollung)
}
}
],
"reports": [ //List of unproductive time entries which are true in this pay period for the employee in this object
{
"unproductive": {
"start": "20220601", //Unproductive time entry start date
"end": "20220601", //Unproductive time entry end date
"id": "301", //Unproductive time entry's id
"days": "1.0" //Unproductive time entry's amount of days
}
},
{
"unproductive": {
"start": "20220602",
"end": "20220602",
"id": "301",
"days": "1.0"
}
},
{
"unproductive": {
"start": "20220603",
"end": "20220603",
"id": "301",
"days": "1.0"
}
},
{
"unproductive": {
"start": "20220627",
"end": "20220627",
"id": "301",
"days": "1.0"
}
},
{
"unproductive": {
"start": "20220628",
"end": "20220628",
"id": "301",
"days": "1.0"
}
},
{
"unproductive": {
"start": "20220629",
"end": "20220629",
"id": "301",
"days": "1.0"
}
}
],
"dismissals": null //Information about dismissals if true in this pay period for the employee in this object
},
{
"employee": { //Another data for another employee
"id": "1"
},
"dismissals": {
"id": "1", //Dismissals id
"date": "20190520", //Date of dismissal
"reason": "17", //Reason of dismissal
"wage_type_id": "950", //Wage types id for dismissal
"settle_hours": "10", //Amount of remaining hours to settle
"settle_vacation_days": "2" //Amount of remaining vacation days to settle
}
}
]
}
]
}