Pay types

Payroll pay types.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(6)	Short name of the pay type.
description	string(40)	Description of the pay type.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
vacation	integer	1 when hours under this pay type draw down vacation accrual.
sick	integer	1 when hours under this pay type draw down sick accrual.
exclude_from_hours_worked	integer	1 excludes hours under this pay type from hours-worked totals (e.g. bonuses).
ar	boolean	True offers the pay type when billing time in AR and service orders.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
pr	boolean	True offers the pay type in payroll time entry.
specialpurpose	string(5)	Marker for system-managed pay types (e.g. CTE/CTU for comp-time earned/used); empty for ordinary pay types.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/prpaytypes/batch 207

Create many.

Requires scope payroll:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(6)	Short name of the pay type.
description	string(40)	Description of the pay type.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
vacation	integer	1 when hours under this pay type draw down vacation accrual.
sick	integer	1 when hours under this pay type draw down sick accrual.
exclude_from_hours_worked	integer	1 excludes hours under this pay type from hours-worked totals (e.g. bonuses).
ar	boolean	True offers the pay type when billing time in AR and service orders.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
pr	boolean	True offers the pay type in payroll time entry.
specialpurpose	string(5)	Marker for system-managed pay types (e.g. CTE/CTU for comp-time earned/used); empty for ordinary pay types.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/prpaytypes/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "name": "Example name",
        "description": "Example description",
        "multiplier": "Example multiplier",
        "vacation": 1,
        "sick": 1,
        "exclude_from_hours_worked": 1
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'name' => 'Example name',
      'description' => 'Example description',
      'multiplier' => 'Example multiplier',
      'vacation' => 1,
      'sick' => 1,
      'exclude_from_hours_worked' => 1,
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/prpaytypes/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "name": "Example name",
            "description": "Example description",
            "multiplier": "Example multiplier",
            "vacation": 1,
            "sick": 1,
            "exclude_from_hours_worked": 1,
        },
    ],
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes/batch',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify([
      {
        name: "Example name",
        description: "Example description",
        multiplier: "Example multiplier",
        vacation: 1,
        sick: 1,
        exclude_from_hours_worked: 1,
      },
    ]),
  }
);
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 {
        name = "Example name",
        description = "Example description",
        multiplier = "Example multiplier",
        vacation = 1,
        sick = 1,
        exclude_from_hours_worked = 1,
    },
};

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

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

GET/prpaytypes 200403

List pay types.

Requires scope payroll:read.

Parameters

Name	In	Type	Notes
description	query	string	description. Partial match, case-insensitive.
name	query	string	Partial match, case insensitive.
cancel	query	string	Defaults to `false`. Pass `true` or `any`.
externalid	query	string	Exact match on your own key.
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 read scope.

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

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes');
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/prpaytypes",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes',
  {
    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/prpaytypes");
res.EnsureSuccessStatusCode();

POST/prpaytypes 201400

Create.

Requires scope payroll:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
name	string(6)	Short name of the pay type.
description	string(40)	Description of the pay type.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
vacation	integer	1 when hours under this pay type draw down vacation accrual.
sick	integer	1 when hours under this pay type draw down sick accrual.
exclude_from_hours_worked	integer	1 excludes hours under this pay type from hours-worked totals (e.g. bonuses).
ar	boolean	True offers the pay type when billing time in AR and service orders.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
pr	boolean	True offers the pay type in payroll time entry.
specialpurpose	string(5)	Marker for system-managed pay types (e.g. CTE/CTU for comp-time earned/used); empty for ordinary pay types.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
400	invalid_request	A required field was missing.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/prpaytypes' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'description' => 'Example description',
    'multiplier' => 'Example multiplier',
    'vacation' => 1,
    'sick' => 1,
    'exclude_from_hours_worked' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/prpaytypes",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "description": "Example description",
        "multiplier": "Example multiplier",
        "vacation": 1,
        "sick": 1,
        "exclude_from_hours_worked": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes',
  {
    method: 'POST',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      description: "Example description",
      multiplier: "Example multiplier",
      vacation: 1,
      sick: 1,
      exclude_from_hours_worked: 1,
    }),
  }
);
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 {
    name = "Example name",
    description = "Example description",
    multiplier = "Example multiplier",
    vacation = 1,
    sick = 1,
    exclude_from_hours_worked = 1,
};

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

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

Response 201

{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}

GET/prpaytypes/{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/prpaytypes/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes/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/prpaytypes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes/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/prpaytypes/104");
res.EnsureSuccessStatusCode();

Response 200

{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}

PATCH/prpaytypes/{id} 200404

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.
name	string(6)	Short name of the pay type.
description	string(40)	Description of the pay type.
multipliernumber	string(2dp)	Numeric string, 2 decimal places. Not money - do not apply currency rounding.
vacation	integer	1 when hours under this pay type draw down vacation accrual.
sick	integer	1 when hours under this pay type draw down sick accrual.
exclude_from_hours_worked	integer	1 excludes hours under this pay type from hours-worked totals (e.g. bonuses).
ar	boolean	True offers the pay type when billing time in AR and service orders.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
entrydateread-only	string	When the record was created.
pr	boolean	True offers the pay type in payroll time entry.
specialpurpose	string(5)	Marker for system-managed pay types (e.g. CTE/CTU for comp-time earned/used); empty for ordinary pay types.
externalid	string(100)	Your own key. Scoped to your company.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

curl -X PATCH \
  'https://acme.nolapro.com/!/api/v2/prpaytypes/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'name' => 'Example name',
    'description' => 'Example description',
    'multiplier' => 'Example multiplier',
    'vacation' => 1,
    'sick' => 1,
    'exclude_from_hours_worked' => 1,
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/prpaytypes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "name": "Example name",
        "description": "Example description",
        "multiplier": "Example multiplier",
        "vacation": 1,
        "sick": 1,
        "exclude_from_hours_worked": 1,
    },
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes/104',
  {
    method: 'PATCH',
    headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` },
    body: JSON.stringify({
      name: "Example name",
      description: "Example description",
      multiplier: "Example multiplier",
      vacation: 1,
      sick: 1,
      exclude_from_hours_worked: 1,
    }),
  }
);
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 {
    name = "Example name",
    description = "Example description",
    multiplier = "Example multiplier",
    vacation = 1,
    sick = 1,
    exclude_from_hours_worked = 1,
};

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

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

Response 200

{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}

DELETE/prpaytypes/{id} 200404

Cancel.

Requires scope payroll:cancel.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

When it fails

Status	Code	Meaning
404	not_found	No record with that id.

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

$ch = curl_init('https://acme.nolapro.com/!/api/v2/prpaytypes/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/prpaytypes/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
)
r.raise_for_status()

const res = await fetch(
  'https://acme.nolapro.com/!/api/v2/prpaytypes/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/prpaytypes/104");

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

Response 200

{
    "name": "Example name",
    "description": "Example description",
    "multiplier": "Example multiplier",
    "vacation": 1,
    "sick": 1,
    "exclude_from_hours_worked": 1
}

Projects →

Projects. projectcode is the display id (TPM-001).

Tasks →

Tasks. parenttaskid nests one level only; taskseq is the per-project number.