{
  "opencollection": "1.0.0",
  "info": {
    "name": "When I Work API Documentation Accounts Payrolls API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Payrolls",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Payrolls",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/payrolls",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Start date of search range (datetime formatted ISO8601)"
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "End date of search range (datetime formatted ISO8601)"
              }
            ]
          },
          "docs": "Listing of payroll periods and totals within a specified date range for an account."
        },
        {
          "info": {
            "name": "Get Payroll",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/payrolls/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the payroll period requested."
              }
            ]
          },
          "docs": "Get an existing payroll period by ID"
        },
        {
          "info": {
            "name": "Update Payroll",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.wheniwork.com/2/payrolls/:id",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update a selected payroll. The PUT body can include fields from the Payroll Object."
        },
        {
          "info": {
            "name": "Get Payroll Statistics for current hours",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/payrolls/:id/stats",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The ID of the payroll period requested."
              },
              {
                "name": "mapObjects",
                "value": "",
                "type": "query",
                "description": "Force structured listings to use maps by ID and not arrays"
              }
            ]
          },
          "docs": "Get the aggregate statistics for payroll period by ID"
        },
        {
          "info": {
            "name": "List Notices",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.wheniwork.com/2/payrolls/notices",
            "params": [
              {
                "name": "ignoreDismissedAt",
                "value": "true",
                "type": "query",
                "description": "Sometimes you may want to view notices that have already been dismissed. Set this parameter to `true` to view\nall notices regardless of when they've been dismissed.\n"
              },
              {
                "name": "rangeInDays",
                "value": "-7",
                "type": "query",
                "description": "Limit the range of the notices that will be returned. By default, the endpoint will pull in everything since\nthe last time the user dismissed notices. This parameter can help restrict the window further.\n"
              }
            ]
          },
          "docs": "Get all attendance notices since the last time they were dismissed. Attendance notices can be generated by\nabsences, early/late clock ins/outs, no shows, etc.\n"
        }
      ]
    }
  ],
  "bundled": true
}