Skip to main content
POST
/
allowance_line_items
/
search
Search allowance line items
curl --request POST \
  --url https://sandbox.nmbr.co/services/payroll/allowance_line_items/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/allowance_line_items/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/allowance_line_items/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/allowance_line_items/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/allowance_line_items/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/allowance_line_items/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/allowance_line_items/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": "allowance_line_item",
      "data": {
        "pay_stub": {
          "id": "<id>",
          "object": "pay_stub",
          "links": {
            "self": "/pay_stubs/<id>"
          }
        },
        "line_item_type": "allowance",
        "is_managed": false,
        "amount": 35,
        "custom_amount": null,
        "managed_amount": 35,
        "accrued_vacation_pay": 0,
        "allowance_type": {
          "id": "<id>",
          "object": "allowance_type",
          "data": {
            "type": "automobile_and_motor_vehicle",
            "label": "Vehicle allowance (taxable)"
          },
          "links": {
            "self": "/allowance_types/automobile_and_motor_vehicle"
          }
        },
        "recurrence": null,
        "title": null,
        "title_translations": null,
        "title_translated": null,
        "business_preset": null,
        "source_adjustment": null,
        "expense_accounting_code": null,
        "managed_expense_accounting_code": null,
        "custom_expense_accounting_code": null,
        "liability_accounting_code": null,
        "managed_liability_accounting_code": null,
        "custom_liability_accounting_code": null,
        "component_settings": {
          "attributes_locked": false
        },
        "earned_on": null,
        "managed_earned_on": null,
        "custom_earned_on": null,
        "external_ref": null,
        "created_at": "2026-01-01T00:00:00.000000Z",
        "updated_at": "2026-01-01T00:00:00.000000Z"
      },
      "links": {
        "self": "/allowance_line_items/<id>"
      }
    }
  ],
  "links": {
    "first": "http://localhost/allowance_line_items/search?page=1",
    "last": "http://localhost/allowance_line_items/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
pay_stubs
object
required
has_business_preset
boolean
business_presets
object
expense_accounting_codes
object
liability_accounting_codes
object
subtypes
object
ids
object

Response

200 - application/json

OK

object
string
read-only

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

data
object[]