Skip to main content
POST
/
pay_stubs
/
search
Search pay stubs
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/pay_stubs/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payroll_id": "<id>",
  "pay_stubs": {
    "include": "all"
  }
}
'
import requests

url = "https://sandbox.nmbr.co/services/payroll/pay_stubs/search"

payload = {
"payroll_id": "<id>",
"pay_stubs": { "include": "all" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({payroll_id: '<id>', pay_stubs: {include: 'all'}})
};

fetch('https://sandbox.nmbr.co/services/payroll/pay_stubs/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.nmbr.co/services/payroll/pay_stubs/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'payroll_id' => '<id>',
'pay_stubs' => [
'include' => 'all'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://sandbox.nmbr.co/services/payroll/pay_stubs/search"

payload := strings.NewReader("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://sandbox.nmbr.co/services/payroll/pay_stubs/search")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://sandbox.nmbr.co/services/payroll/pay_stubs/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payroll_id\": \"<id>\",\n \"pay_stubs\": {\n \"include\": \"all\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "object": "list",
  "data": [
    {
      "id": "<id>",
      "object": "pay_stub",
      "data": {
        "payroll": {
          "id": "<id>",
          "object": "payroll",
          "links": {
            "self": "/payrolls/<id>"
          }
        },
        "work_assignment": {
          "id": "<id>",
          "object": "work_assignment",
          "links": {
            "self": "/work_assignments/<id>"
          }
        },
        "payment_method": "direct_deposit",
        "has_taxes_calculated": true,
        "is_pending_tax_rates": false,
        "employee_summary": {
          "gross": 0,
          "subtractions": 0,
          "reimbursements": 0,
          "net": 0,
          "gross_ytd": 0,
          "subtractions_ytd": 0,
          "reimbursements_ytd": 0,
          "net_ytd": 0
        },
        "contractor_summary": {
          "gross": null,
          "reimbursements": null,
          "net": null,
          "gross_ytd": 0,
          "reimbursements_ytd": 0,
          "net_ytd": 0
        },
        "company_summary": {
          "taxes_and_contributions": 0,
          "benefits": 0,
          "total": 0,
          "taxes_and_contributions_ytd": 0,
          "benefits_ytd": 0,
          "total_ytd": 0
        },
        "vacation_pay_balance": 0,
        "liability": 0,
        "cash_requirement": 0,
        "note": null,
        "line_item_summary": {
          "earnings": {
            "period": 0,
            "period_managed": 0,
            "period_unmanaged": 0,
            "ytd": 0
          },
          "statutory_withholdings": {
            "period": 0,
            "ytd": 0
          },
          "reimbursements": {
            "period": 0,
            "ytd": 0
          },
          "allowances": {
            "period": 0,
            "ytd": 0
          },
          "benefits": {
            "period": 0,
            "ytd": 0
          },
          "employee_benefits": {
            "period": 0,
            "ytd": 0
          },
          "employer_benefits": {
            "period": 0,
            "ytd": 0
          },
          "deductions": {
            "period": 0,
            "ytd": 0
          }
        },
        "is_stale": false,
        "stale_since": null,
        "warnings": {
          "object": "list",
          "data": []
        },
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/pay_stubs/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/pay_stubs/search?page=1",
    "last": "http://localhost/pay_stubs/search?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "has_more": false
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
payroll_id
string
required

The payroll whose pay stubs to search.

pay_stubs
object
required

The selection criteria.

pay_stubs.include must be either the string "all", or an object containing one or more of ids (string array), work_assignment_ids (string array - selects the stubs for those work assignments), payee_type (employee or contractor).

pay_stubs.exclude (optional) is an object containing one or more of the same keys.

Response

200 - application/json

OK

object
string
read-only

The type of the object in Nmbr ("list").

data
object[]