Units

Rentable units in a building.

The object#

Field	Type	Description
idread-only	integer	NolaPro id.
buildingid	integer	Buildingid. Id only.
name	string(100)	Unit name or number within the building.
subname	string(100)	Secondary name line for the unit (e.g. suite or room).
description	text	Description. Stored as `text`, no practical length limit.
squarefeet	integer	Floor area of the unit in square feet.
rentamountmoney	string(6dp)	Stored as `decimal(19,6)`.
rentperiod	string(5)	Rent Period the unit is normally let by: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly.
underrepair	integer	1 while the unit is under repair and not rentable.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
beds	integer	Number of bedrooms.
bathsmoney	string(1dp)	Stored as `decimal(4,1)`.
furnished	integer	1 when the unit is furnished.
den	integer	1 when the unit has a den.
fireplace	integer	1 when the unit has a fireplace.
carpet	integer	1 when the unit is carpeted.
drapes	integer	1 when drapes are provided.
airconditioning	integer	1 when the unit has air conditioning.
stove	integer	1 when a stove is provided.
washerdryerhookup	integer	1 when the unit has washer/dryer hookups.
washer	integer	1 when a washer is provided.
dryer	integer	1 when a dryer is provided.
refrigerator	integer	1 when a refrigerator is provided.
dishwasher	integer	1 when a dishwasher is provided.
disposal	integer	1 when a garbage disposal is provided.
externalid	string(100)	Your own key. Scoped to your company.

Endpoints#

POST/units/batch 207

Create many.

Requires scope properties:write.

Parameters

Name	In	Type	Notes

Body array

Field	Type	Description
idread-only	integer	NolaPro id.
buildingid	integer	Buildingid. Id only.
name	string(100)	Unit name or number within the building.
subname	string(100)	Secondary name line for the unit (e.g. suite or room).
description	text	Description. Stored as `text`, no practical length limit.
squarefeet	integer	Floor area of the unit in square feet.
rentamountmoney	string(6dp)	Stored as `decimal(19,6)`.
rentperiod	string(5)	Rent Period the unit is normally let by: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly.
underrepair	integer	1 while the unit is under repair and not rentable.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
beds	integer	Number of bedrooms.
bathsmoney	string(1dp)	Stored as `decimal(4,1)`.
furnished	integer	1 when the unit is furnished.
den	integer	1 when the unit has a den.
fireplace	integer	1 when the unit has a fireplace.
carpet	integer	1 when the unit is carpeted.
drapes	integer	1 when drapes are provided.
airconditioning	integer	1 when the unit has air conditioning.
stove	integer	1 when a stove is provided.
washerdryerhookup	integer	1 when the unit has washer/dryer hookups.
washer	integer	1 when a washer is provided.
dryer	integer	1 when a dryer is provided.
refrigerator	integer	1 when a refrigerator is provided.
dishwasher	integer	1 when a dishwasher is provided.
disposal	integer	1 when a garbage disposal is provided.
externalid	string(100)	Your own key. Scoped to your company.

curl -X POST \
  'https://acme.nolapro.com/!/api/v2/units/batch' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '[
    {
        "buildingid": 104,
        "name": "Example name",
        "subname": "Example subname",
        "description": "Example description",
        "squarefeet": 1,
        "rentamount": "125.0000"
    }
]'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/units/batch');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    [
      'buildingid' => 104,
      'name' => 'Example name',
      'subname' => 'Example subname',
      'description' => 'Example description',
      'squarefeet' => 1,
      'rentamount' => '125.0000',
    ],
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/units/batch",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json=[
        {
            "buildingid": 104,
            "name": "Example name",
            "subname": "Example subname",
            "description": "Example description",
            "squarefeet": 1,
            "rentamount": "125.0000",
        },
    ],
)
r.raise_for_status()

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

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

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

GET/units 200403

List units.

Requires scope properties: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/units' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

POST/units 201400

Create.

Requires scope properties:write.

Parameters

Name	In	Type	Notes

Body

Field	Type	Description
idread-only	integer	NolaPro id.
buildingid	integer	Buildingid. Id only.
name	string(100)	Unit name or number within the building.
subname	string(100)	Secondary name line for the unit (e.g. suite or room).
description	text	Description. Stored as `text`, no practical length limit.
squarefeet	integer	Floor area of the unit in square feet.
rentamountmoney	string(6dp)	Stored as `decimal(19,6)`.
rentperiod	string(5)	Rent Period the unit is normally let by: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly.
underrepair	integer	1 while the unit is under repair and not rentable.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
beds	integer	Number of bedrooms.
bathsmoney	string(1dp)	Stored as `decimal(4,1)`.
furnished	integer	1 when the unit is furnished.
den	integer	1 when the unit has a den.
fireplace	integer	1 when the unit has a fireplace.
carpet	integer	1 when the unit is carpeted.
drapes	integer	1 when drapes are provided.
airconditioning	integer	1 when the unit has air conditioning.
stove	integer	1 when a stove is provided.
washerdryerhookup	integer	1 when the unit has washer/dryer hookups.
washer	integer	1 when a washer is provided.
dryer	integer	1 when a dryer is provided.
refrigerator	integer	1 when a refrigerator is provided.
dishwasher	integer	1 when a dishwasher is provided.
disposal	integer	1 when a garbage disposal is provided.
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/units' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/units');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'POST',
  CURLOPT_POSTFIELDS     => json_encode([
    'buildingid' => 104,
    'name' => 'Example name',
    'subname' => 'Example subname',
    'description' => 'Example description',
    'squarefeet' => 1,
    'rentamount' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.post(
    "https://acme.nolapro.com/!/api/v2/units",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "buildingid": 104,
        "name": "Example name",
        "subname": "Example subname",
        "description": "Example description",
        "squarefeet": 1,
        "rentamount": "125.0000",
    },
)
r.raise_for_status()

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

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

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

Response 201

{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}

GET/units/{id} 200404

Retrieve one record.

Requires scope properties: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/units/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

Response 200

{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}

PATCH/units/{id} 200404

Update.

Requires scope properties:write.

Parameters

Name	In	Type	Notes
idrequired	path	integer	The record id.

Body

Field	Type	Description
idread-only	integer	NolaPro id.
buildingid	integer	Buildingid. Id only.
name	string(100)	Unit name or number within the building.
subname	string(100)	Secondary name line for the unit (e.g. suite or room).
description	text	Description. Stored as `text`, no practical length limit.
squarefeet	integer	Floor area of the unit in square feet.
rentamountmoney	string(6dp)	Stored as `decimal(19,6)`.
rentperiod	string(5)	Rent Period the unit is normally let by: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly.
underrepair	integer	1 while the unit is under repair and not rentable.
entrydateread-only	string	When the record was created.
cancel	boolean	Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
beds	integer	Number of bedrooms.
bathsmoney	string(1dp)	Stored as `decimal(4,1)`.
furnished	integer	1 when the unit is furnished.
den	integer	1 when the unit has a den.
fireplace	integer	1 when the unit has a fireplace.
carpet	integer	1 when the unit is carpeted.
drapes	integer	1 when drapes are provided.
airconditioning	integer	1 when the unit has air conditioning.
stove	integer	1 when a stove is provided.
washerdryerhookup	integer	1 when the unit has washer/dryer hookups.
washer	integer	1 when a washer is provided.
dryer	integer	1 when a dryer is provided.
refrigerator	integer	1 when a refrigerator is provided.
dishwasher	integer	1 when a dishwasher is provided.
disposal	integer	1 when a garbage disposal is provided.
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/units/104' \
  -H 'Authorization: Bearer $NP_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: your-unique-key' \
  -d '{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}'

$ch = curl_init('https://acme.nolapro.com/!/api/v2/units/104');
curl_setopt_array($ch, [
  CURLOPT_HTTPHEADER     => ['Authorization: Bearer ' . getenv('NP_TOKEN')],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST  => 'PATCH',
  CURLOPT_POSTFIELDS     => json_encode([
    'buildingid' => 104,
    'name' => 'Example name',
    'subname' => 'Example subname',
    'description' => 'Example description',
    'squarefeet' => 1,
    'rentamount' => '125.0000',
  ]),
]);
$res = json_decode(curl_exec($ch), true);

import os, requests

r = requests.patch(
    "https://acme.nolapro.com/!/api/v2/units/104",
    headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"},
    json={
        "buildingid": 104,
        "name": "Example name",
        "subname": "Example subname",
        "description": "Example description",
        "squarefeet": 1,
        "rentamount": "125.0000",
    },
)
r.raise_for_status()

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

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

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

Response 200

{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}

DELETE/units/{id} 200404

Cancel.

Requires scope properties: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/units/104' \
  -H 'Authorization: Bearer $NP_TOKEN'

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

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

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

Response 200

{
    "buildingid": 104,
    "name": "Example name",
    "subname": "Example subname",
    "description": "Example description",
    "squarefeet": 1,
    "rentamount": "125.0000"
}

Sites →

Physical sites a job runs at.

Estimating quotes →

Quotes from the Estimating module. A different thing from an AR quote, which is an order with status quote - see the orders resource. ordertype 2 is a rental order, not a quote.