Payrolls

The API functions for Payrolls in Papershift



Get Payrolls

Get Payrolls from your Papershift account

URL

https://app.papershift.com/public_api/v1/payrolls

Method

GET

Parameters

ParameterTypeRequiered
api_tokenStringrequired
user_idIntegerrequired
user_external_idStringrequired if user_id not set
pageIntegeroptional

Information

A successful request returns all payroll entries associated with the provided date filter inputs.

Example

{
  "api_token" : "6ooIiSZaiBwaFBLxveJkm7pP8uTOPLPSwDL6QsOK",
  "user_id": 1,
  "page": 2
}
function getPayrolls() {
  $.ajax({
    url: "https://app.papershift.com/public_api/v1/payrolls?api_token=6ooIiSZaiBwaFBLxveJkm7pP8uTOPLPSwDL6QsOK&user_id=1&page=2",
    type: 'GET',
    dataType: 'json',
    data: JSON.stringify(params),
    complete: function (data) {
      console.log(data.responseText);
    }
  });
}
{
    "payrolls": [
        {
            "id": 1129289,
            "paid_hours": 35.0,
            "salary": 0.0,
            "day": "2025-03-31",
            "user_id": 324,
            "created_at": "2025-03-20T08:19:40Z",
            "updated_at": "2025-03-20T08:19:40Z",
            "time_account_start": 0.0,
            "calc_hours": 35.0,
            "bonus": 0.0,
            "time_account_end": 0.0,
            "selected_data": "plan-actual",
            "payroll_visible": true,
            "additional_charged_hours": 0.0
        }
    ],
    "page_number": 1,
    "total_pages": 1,
    "next_page": null
}