Departments

Departments, used for payroll expense allocation. Each carries the GL accounts wages and taxes post to.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(45)	The code.
name	string(100)	Label.
glwageexpenseid	integer	Wage expense account. Id only - the table this points at is not identifiable from the column name, so there is no human key to send instead.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this departments. Scoped to your company.

Endpoints#

POST/departments/batch 207

Create many.

Requires scope payroll:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(45)	The code.
name	string(100)	Label.
glwageexpenseid	integer	Wage expense account. Id only - the table this points at is not identifiable from the column name, so there is no human key to send instead.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this departments. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/departments/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "id": 1,
        "code": "SHIP",
        "name": "Shipping",
        "glwageexpenseid": 0,
        "cancel": false
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'id' => 1,
      'code' => 'SHIP',
      'name' => 'Shipping',
      'glwageexpenseid' => 0,
      'cancel' => false,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/departments/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "id": 1,
            "code": "SHIP",
            "name": "Shipping",
            "glwageexpenseid": 0,
            "cancel": False,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        id: 1,
        code: "SHIP",
        name: "Shipping",
        glwageexpenseid: 0,
        cancel: false,
      },
    ]),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new[] {
    new {
        id = 1,
        code = "SHIP",
        name = "Shipping",
        glwageexpenseid = 0,
        cancel = false,
    },
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/departments/batch") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

GET/departments 200403

List departments.

Requires scope payroll:read.

Parameters

Name	In	Type	Notes
name	query	string	name. Partial match, case-insensitive.
code	query	string	code. Partial match, case-insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key. Scoped to your company.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
403	insufficient_scope	Token lacks `departments:read`.

curl \
  'https://acme.nolapro.com/!/api/v2/departments' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/departments",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/departments");
res.EnsureSuccessStatusCode();

POST/departments 201400409

Create.

Requires scope payroll:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(45)	The code.
name	string(100)	Label.
glwageexpenseid	integer	Wage expense account. Id only - the table this points at is not identifiable from the column name, so there is no human key to send instead.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this departments. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.
409	duplicate	That code is already in use.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/departments' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'code' => 'SHIP',
    'name' => 'Shipping',
    'glwageexpenseid' => 0,
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/departments",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "code": "SHIP",
        "name": "Shipping",
        "glwageexpenseid": 0,
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      code: "SHIP",
      name: "Shipping",
      glwageexpenseid: 0,
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 1,
    code = "SHIP",
    name = "Shipping",
    glwageexpenseid = 0,
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Post,
    "https://acme.nolapro.com/!/api/v2/departments") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 201

{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}

GET/departments/{id} 200404

Retrieve one record.

Requires scope payroll:read.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.
include	query	string	Comma-separated extras to embed. Only `custom_fields` is available: the extra fields this install has defined on the record. Off by default, and an unrecognised value is refused rather than ignored. See Conventions.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl \
  'https://acme.nolapro.com/!/api/v2/departments/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.get(
    "https://acme.nolapro.com/!/api/v2/departments/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments/104',
  {
    method: 'GET',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var res = await http.GetAsync(
    "https://acme.nolapro.com/!/api/v2/departments/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}

PATCH/departments/{id} 200404409

Update.

Requires scope payroll:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
code	string(45)	The code.
name	string(100)	Label.
glwageexpenseid	integer	Wage expense account. Id only - the table this points at is not identifiable from the column name, so there is no human key to send instead.
cancel	boolean	True once cancelled.
externalid	string(100)	Your own key for this departments. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.
409	stale_record	`If-Match` did not match.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/departments/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'id' => 1,
    'code' => 'SHIP',
    'name' => 'Shipping',
    'glwageexpenseid' => 0,
    'cancel' => false,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/departments/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "id": 1,
        "code": "SHIP",
        "name": "Shipping",
        "glwageexpenseid": 0,
        "cancel": False,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      id: 1,
      code: "SHIP",
      name: "Shipping",
      glwageexpenseid: 0,
      cancel: false,
    }),
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var body = new {
    id = 1,
    code = "SHIP",
    name = "Shipping",
    glwageexpenseid = 0,
    cancel = false,
};

var req = new HttpRequestMessage(HttpMethod.Patch,
    "https://acme.nolapro.com/!/api/v2/departments/104") {
    Content = JsonContent.Create(body),
};
req.Headers.Add("Idempotency-Key", "your-unique-key");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}

DELETE/departments/{id} 200403404

Cancel.

Requires scope payroll:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
403	insufficient_scope	Needs `departments:cancel`.
404	not_found	No record with that id.

curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/departments/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/departments/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'DELETE',
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.delete(
    "https://acme.nolapro.com/!/api/v2/departments/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/departments/104',
  {
    method: 'DELETE',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
  }
);
const data = await res.json();

using System.Net.Http.Json;

var token = Environment.GetEnvironmentVariable("NP_TOKEN");

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token);

var req = new HttpRequestMessage(HttpMethod.Delete,
    "https://acme.nolapro.com/!/api/v2/departments/104");

var res = await http.SendAsync(req);
res.EnsureSuccessStatusCode();

Response 200

{
    "id": 1,
    "code": "SHIP",
    "name": "Shipping",
    "glwageexpenseid": 0,
    "cancel": false
}

Employees →

Read-only and minimal, for the same reason as users, only more so. The stored row carries social security numbers, pay rates, bank details and tax withholding. None of that is returned and none of it is writable. This resource exists only so salesman.payrollid can be resolved to a name.

Pay types →

Payroll pay types.