Buildings
Buildings that rentable units belong to.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| code | string(20) | Short code identifying the building. |
| name | string(100) | Building name. |
| address1 | string(100) | Street address. |
| address2 | string(100) | Second address line. |
| city | string(50) | City of the building address. |
| state | string(20) | State of the building address. |
| zip | string(15) | Postal code. |
| description | text | Description. Stored as text, no practical length limit. |
| managementfeemoney | string(2dp) | Stored as decimal(6,2). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| utilitiescharge | string(5) | How tenant utilities are billed: A = all usage, O = overage over the cap only. |
| electricbasismoney | string(6dp) | Stored as decimal(19,6). |
| waterbasismoney | string(6dp) | Stored as decimal(19,6). |
| gasbasismoney | string(6dp) | Stored as decimal(19,6). |
| buildingtypeid | integer | Buildingtypeid. Id only. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| areaid | integer | Reference to areas, by id. Write either this or area. |
| area | string(100) | The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree. |
| firstnotice | integer | Days past due before the first late notice is sent. |
| secondnotice | integer | Days past due before the second late notice is sent. |
| finalnotice | integer | Days past due before the final late notice is sent. |
| asleasetemplateid | string(45) | E-signature template id for the lease agreement, 3-signer variant. |
| asleasetemplateid2 | string(45) | E-signature template id for the lease agreement, 2-signer variant. |
| asleasedocname | string(100) | Document name given to the lease agreement when it is sent for e-signature. |
| docexpirationdays | integer | Days until an e-signature request for this building’s documents expires. |
| asguarantordocname | string(100) | Document name given to the guarantor agreement when it is sent for e-signature. |
| asguarantortemplateid | string(45) | E-signature template id for the guarantor agreement. |
| aspetdocname | string(100) | Document name given to the pet agreement when it is sent for e-signature. |
| aspettemplateid | string(45) | E-signature template id for the pet agreement. |
| asterminationdocname | string(100) | Document name given to the termination document when it is sent for e-signature. |
| asterminationtemplateid | string(45) | E-signature template id for the lease termination, 3-signer variant. |
| asterminationtemplateid2 | string(45) | E-signature template id for the lease termination, 2-signer variant. |
| firstinvoicemonths | integer | Months before the move-in date that the first lease invoice comes due (0-11). |
| asamendmenttemplateid | string(45) | E-signature template id for a lease amendment. |
| asamendmentdocname | string(100) | Document name given to the amendment when it is sent for e-signature. |
| asleasetemplateid4 | string(45) | E-signature template id for the lease agreement, 4-signer variant. |
| addressverifiedread-only | string(32) | Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API. |
| externalid | string(100) | Your own key. Scoped to your company. |
Endpoints#
Create many.
Requires scope properties:write.
| Name | In | Type | Notes |
|---|---|---|---|
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| code | string(20) | Short code identifying the building. |
| name | string(100) | Building name. |
| address1 | string(100) | Street address. |
| address2 | string(100) | Second address line. |
| city | string(50) | City of the building address. |
| state | string(20) | State of the building address. |
| zip | string(15) | Postal code. |
| description | text | Description. Stored as text, no practical length limit. |
| managementfeemoney | string(2dp) | Stored as decimal(6,2). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| utilitiescharge | string(5) | How tenant utilities are billed: A = all usage, O = overage over the cap only. |
| electricbasismoney | string(6dp) | Stored as decimal(19,6). |
| waterbasismoney | string(6dp) | Stored as decimal(19,6). |
| gasbasismoney | string(6dp) | Stored as decimal(19,6). |
| buildingtypeid | integer | Buildingtypeid. Id only. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| areaid | integer | Reference to areas, by id. Write either this or area. |
| area | string(100) | The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree. |
| firstnotice | integer | Days past due before the first late notice is sent. |
| secondnotice | integer | Days past due before the second late notice is sent. |
| finalnotice | integer | Days past due before the final late notice is sent. |
| asleasetemplateid | string(45) | E-signature template id for the lease agreement, 3-signer variant. |
| asleasetemplateid2 | string(45) | E-signature template id for the lease agreement, 2-signer variant. |
| asleasedocname | string(100) | Document name given to the lease agreement when it is sent for e-signature. |
| docexpirationdays | integer | Days until an e-signature request for this building’s documents expires. |
| asguarantordocname | string(100) | Document name given to the guarantor agreement when it is sent for e-signature. |
| asguarantortemplateid | string(45) | E-signature template id for the guarantor agreement. |
| aspetdocname | string(100) | Document name given to the pet agreement when it is sent for e-signature. |
| aspettemplateid | string(45) | E-signature template id for the pet agreement. |
| asterminationdocname | string(100) | Document name given to the termination document when it is sent for e-signature. |
| asterminationtemplateid | string(45) | E-signature template id for the lease termination, 3-signer variant. |
| asterminationtemplateid2 | string(45) | E-signature template id for the lease termination, 2-signer variant. |
| firstinvoicemonths | integer | Months before the move-in date that the first lease invoice comes due (0-11). |
| asamendmenttemplateid | string(45) | E-signature template id for a lease amendment. |
| asamendmentdocname | string(100) | Document name given to the amendment when it is sent for e-signature. |
| asleasetemplateid4 | string(45) | E-signature template id for the lease agreement, 4-signer variant. |
| addressverifiedread-only | string(32) | Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API. |
| externalid | string(100) | Your own key. Scoped to your company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/buildings/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state" } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ 'code' => 'ACME-01', 'name' => 'Example name', 'address1' => 'Example address1', 'address2' => 'Example address2', 'city' => 'Example city', 'state' => 'Example state', ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/buildings/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state", }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { code: "ACME-01", name: "Example name", address1: "Example address1", address2: "Example address2", city: "Example city", state: "Example state", }, ]), } ); 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 { code = "ACME-01", name = "Example name", address1 = "Example address1", address2 = "Example address2", city = "Example city", state = "Example state", }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/buildings/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
List buildings.
Requires scope properties:read.
| Name | In | Type | Notes |
|---|---|---|---|
| description | query | string | description. Partial match, case-insensitive. |
| code | query | string | code. 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. |
| Status | Code | Meaning |
|---|---|---|
| 403 | insufficient_scope | Token lacks read scope. |
curl \ 'https://acme.nolapro.com/!/api/v2/buildings' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings'); 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/buildings", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings', { 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/buildings"); res.EnsureSuccessStatusCode();
Create.
Requires scope properties:write.
| Name | In | Type | Notes |
|---|---|---|---|
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| code | string(20) | Short code identifying the building. |
| name | string(100) | Building name. |
| address1 | string(100) | Street address. |
| address2 | string(100) | Second address line. |
| city | string(50) | City of the building address. |
| state | string(20) | State of the building address. |
| zip | string(15) | Postal code. |
| description | text | Description. Stored as text, no practical length limit. |
| managementfeemoney | string(2dp) | Stored as decimal(6,2). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| utilitiescharge | string(5) | How tenant utilities are billed: A = all usage, O = overage over the cap only. |
| electricbasismoney | string(6dp) | Stored as decimal(19,6). |
| waterbasismoney | string(6dp) | Stored as decimal(19,6). |
| gasbasismoney | string(6dp) | Stored as decimal(19,6). |
| buildingtypeid | integer | Buildingtypeid. Id only. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| areaid | integer | Reference to areas, by id. Write either this or area. |
| area | string(100) | The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree. |
| firstnotice | integer | Days past due before the first late notice is sent. |
| secondnotice | integer | Days past due before the second late notice is sent. |
| finalnotice | integer | Days past due before the final late notice is sent. |
| asleasetemplateid | string(45) | E-signature template id for the lease agreement, 3-signer variant. |
| asleasetemplateid2 | string(45) | E-signature template id for the lease agreement, 2-signer variant. |
| asleasedocname | string(100) | Document name given to the lease agreement when it is sent for e-signature. |
| docexpirationdays | integer | Days until an e-signature request for this building’s documents expires. |
| asguarantordocname | string(100) | Document name given to the guarantor agreement when it is sent for e-signature. |
| asguarantortemplateid | string(45) | E-signature template id for the guarantor agreement. |
| aspetdocname | string(100) | Document name given to the pet agreement when it is sent for e-signature. |
| aspettemplateid | string(45) | E-signature template id for the pet agreement. |
| asterminationdocname | string(100) | Document name given to the termination document when it is sent for e-signature. |
| asterminationtemplateid | string(45) | E-signature template id for the lease termination, 3-signer variant. |
| asterminationtemplateid2 | string(45) | E-signature template id for the lease termination, 2-signer variant. |
| firstinvoicemonths | integer | Months before the move-in date that the first lease invoice comes due (0-11). |
| asamendmenttemplateid | string(45) | E-signature template id for a lease amendment. |
| asamendmentdocname | string(100) | Document name given to the amendment when it is sent for e-signature. |
| asleasetemplateid4 | string(45) | E-signature template id for the lease agreement, 4-signer variant. |
| addressverifiedread-only | string(32) | Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API. |
| externalid | string(100) | Your own key. Scoped to your company. |
| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A required field was missing. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/buildings' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'code' => 'ACME-01', 'name' => 'Example name', 'address1' => 'Example address1', 'address2' => 'Example address2', 'city' => 'Example city', 'state' => 'Example state', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/buildings", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ code: "ACME-01", name: "Example name", address1: "Example address1", address2: "Example address2", city: "Example city", state: "Example state", }), } ); 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 { code = "ACME-01", name = "Example name", address1 = "Example address1", address2 = "Example address2", city = "Example city", state = "Example state", }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/buildings") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"code": "ACME-01",
"name": "Example name",
"address1": "Example address1",
"address2": "Example address2",
"city": "Example city",
"state": "Example state"
}
Retrieve one record.
Requires scope properties:read.
| 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. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl \ 'https://acme.nolapro.com/!/api/v2/buildings/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/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/buildings/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings/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/buildings/104"); res.EnsureSuccessStatusCode();
{
"code": "ACME-01",
"name": "Example name",
"address1": "Example address1",
"address2": "Example address2",
"city": "Example city",
"state": "Example state"
}
Update.
Requires scope properties:write.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| code | string(20) | Short code identifying the building. |
| name | string(100) | Building name. |
| address1 | string(100) | Street address. |
| address2 | string(100) | Second address line. |
| city | string(50) | City of the building address. |
| state | string(20) | State of the building address. |
| zip | string(15) | Postal code. |
| description | text | Description. Stored as text, no practical length limit. |
| managementfeemoney | string(2dp) | Stored as decimal(6,2). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| utilitiescharge | string(5) | How tenant utilities are billed: A = all usage, O = overage over the cap only. |
| electricbasismoney | string(6dp) | Stored as decimal(19,6). |
| waterbasismoney | string(6dp) | Stored as decimal(19,6). |
| gasbasismoney | string(6dp) | Stored as decimal(19,6). |
| buildingtypeid | integer | Buildingtypeid. Id only. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| areaid | integer | Reference to areas, by id. Write either this or area. |
| area | string(100) | The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree. |
| firstnotice | integer | Days past due before the first late notice is sent. |
| secondnotice | integer | Days past due before the second late notice is sent. |
| finalnotice | integer | Days past due before the final late notice is sent. |
| asleasetemplateid | string(45) | E-signature template id for the lease agreement, 3-signer variant. |
| asleasetemplateid2 | string(45) | E-signature template id for the lease agreement, 2-signer variant. |
| asleasedocname | string(100) | Document name given to the lease agreement when it is sent for e-signature. |
| docexpirationdays | integer | Days until an e-signature request for this building’s documents expires. |
| asguarantordocname | string(100) | Document name given to the guarantor agreement when it is sent for e-signature. |
| asguarantortemplateid | string(45) | E-signature template id for the guarantor agreement. |
| aspetdocname | string(100) | Document name given to the pet agreement when it is sent for e-signature. |
| aspettemplateid | string(45) | E-signature template id for the pet agreement. |
| asterminationdocname | string(100) | Document name given to the termination document when it is sent for e-signature. |
| asterminationtemplateid | string(45) | E-signature template id for the lease termination, 3-signer variant. |
| asterminationtemplateid2 | string(45) | E-signature template id for the lease termination, 2-signer variant. |
| firstinvoicemonths | integer | Months before the move-in date that the first lease invoice comes due (0-11). |
| asamendmenttemplateid | string(45) | E-signature template id for a lease amendment. |
| asamendmentdocname | string(100) | Document name given to the amendment when it is sent for e-signature. |
| asleasetemplateid4 | string(45) | E-signature template id for the lease agreement, 4-signer variant. |
| addressverifiedread-only | string(32) | Hash of the address as it stood when it last passed the AvaTax/USPS address check; when it no longer matches the current address the address counts as unverified. Maintained by the verification flow, so it cannot be written through the API. |
| externalid | string(100) | Your own key. Scoped to your company. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl -X PATCH \ 'https://acme.nolapro.com/!/api/v2/buildings/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'code' => 'ACME-01', 'name' => 'Example name', 'address1' => 'Example address1', 'address2' => 'Example address2', 'city' => 'Example city', 'state' => 'Example state', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/buildings/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "code": "ACME-01", "name": "Example name", "address1": "Example address1", "address2": "Example address2", "city": "Example city", "state": "Example state", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ code: "ACME-01", name: "Example name", address1: "Example address1", address2: "Example address2", city: "Example city", state: "Example state", }), } ); 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 { code = "ACME-01", name = "Example name", address1 = "Example address1", address2 = "Example address2", city = "Example city", state = "Example state", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/buildings/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"code": "ACME-01",
"name": "Example name",
"address1": "Example address1",
"address2": "Example address2",
"city": "Example city",
"state": "Example state"
}
Cancel.
Requires scope properties:cancel.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The record id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No record with that id. |
curl -X DELETE \ 'https://acme.nolapro.com/!/api/v2/buildings/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/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/buildings/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings/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/buildings/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"code": "ACME-01",
"name": "Example name",
"address1": "Example address1",
"address2": "Example address2",
"city": "Example city",
"state": "Example state"
}
List files attached to a building.
The attachments on this building, newest first. Accepted filedefinitionid values: 30, 28, 36 (default 30). Metadata only - each file's bytes are at GET /attachments/{id}/content.
Requires scope properties:read.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The building id. |
| filedefinitionid | query | integer | Only files in this list. Accepted filedefinitionid values: 30, 28, 36 (default 30). |
| filecategoryid | query | integer | Only files filed under this category. |
| filename | query | string | Partial match on the file name, case insensitive. |
| Status | Code | Meaning |
|---|---|---|
| 404 | not_found | No building with that id in this company. |
curl \ 'https://acme.nolapro.com/!/api/v2/buildings/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/104/attachments'); 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/buildings/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/buildings/104/attachments', { 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/buildings/104/attachments"); res.EnsureSuccessStatusCode();
Attach a file to a building.
multipart/form-data with one file part; see the AttachmentUpload schema for the other parts. Accepted filedefinitionid values: 30, 28, 36 (default 30). Answers 201 with the attachment's metadata and Location: /attachments/{id}. Check _meta.warnings for datatype_truncated and stored_under_parent_company.
Requires scope properties:write.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The building id. |
| Idempotency-Key | header | string | Makes the write safely retryable. Any unique string per logical operation; a UUID is fine.
The failure this prevents is specific: the request succeeds, the response is lost to a timeout, you retry, and the customer is billed twice. With a key, the retry returns the original response - same status, same body, same id - and creates nothing.
The body is part of the key's identity. Reusing a key with a different body is a bug on your side, not a retry, and answers 409 idempotency_replay rather than silently handing back the old response. Keys are remembered for 24 hours. |
| Field | Type | Description |
|---|---|---|
| filerequired | string | The file. Exactly one part named file; a second one, or file[], is 400 invalid_request so an idempotent retry can never half-succeed. Empty is refused. Over the cap (the smaller of APIV2_MAX_UPLOAD_BYTES, 64 MB by default, and PHP's upload_max_filesize / post_max_size) is 413 payload_too_large naming the limit that applied. |
| filename | string(255) | Overrides the part's file name. |
| notes | text | Free text shown beside the file. |
| filedefinitionid | integer | Only when the parent accepts more than one list. Anything the parent does not accept is 422 unknown_value naming the accepted ids. |
| filecategoryid | integer | Category by id. |
| filecategory | string(255) | Category by name. Sent with filecategoryid and disagreeing is 422 conflicting_reference. |
| Status | Code | Meaning |
|---|---|---|
| 400 | unknown_parameter | A form field that is not on the AttachmentUpload schema. |
| 400 | invalid_type | filedefinitionid or filecategoryid that is not an integer. |
| 404 | not_found | No building with that id in this company. |
| 409 | upload_limit_reached | This file list allows a fixed number of files on a building and it is full. Remove one first. |
| 413 | payload_too_large | The file is over the cap. The body names the limit that applied. |
| 415 | multipart_required | The body was not multipart/form-data. |
| 422 | unknown_value | filedefinitionid is not one this building accepts, or the category does not exist in this company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/buildings/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Idempotency-Key: your-unique-key' \ -F 'file=@grant-letter-signed.pdf' \ -F 'filename=grant-letter-signed.pdf' \ -F 'notes=Signed copy received 21 Sep' \ -F 'filedefinitionid=8' \ -F 'filecategory=Receipts'
$fields = [ 'filename' => 'grant-letter-signed.pdf', 'notes' => 'Signed copy received 21 Sep', 'filedefinitionid' => '8', 'filecategory' => 'Receipts', ]; $fields['file'] = new CURLFile('grant-letter-signed.pdf'); $ch = curl_init('https://acme.nolapro.com/!/api/v2/buildings/104/attachments'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN'), 'Idempotency-Key: your-unique-key'], CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_POSTFIELDS => $fields, ]); $res = json_decode(curl_exec($ch), true);
import os, requests with open("grant-letter-signed.pdf", "rb") as fh: r = requests.post( "https://acme.nolapro.com/!/api/v2/buildings/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}", "Idempotency-Key": "your-unique-key"}, files={"file": fh}, data={ "filename": "grant-letter-signed.pdf", "notes": "Signed copy received 21 Sep", "filedefinitionid": "8", "filecategory": "Receipts", }, ) r.raise_for_status()
import { openAsBlob } from 'node:fs';
const form = new FormData();
form.append('file', await openAsBlob('grant-letter-signed.pdf'), 'grant-letter-signed.pdf');
form.append('filename', "grant-letter-signed.pdf");
form.append('notes', "Signed copy received 21 Sep");
form.append('filedefinitionid', "8");
form.append('filecategory', "Receipts");
const res = await fetch(
'https://acme.nolapro.com/!/api/v2/buildings/104/attachments',
{
method: 'POST',
headers: { Authorization: `Bearer ${process.env.NP_TOKEN}`, 'Idempotency-Key': 'your-unique-key' },
body: form,
}
);
const data = await res.json();
var token = Environment.GetEnvironmentVariable("NP_TOKEN"); using var http = new HttpClient(); http.DefaultRequestHeaders.Add("Authorization", "Bearer " + token); using var form = new MultipartFormDataContent(); form.Add(new StreamContent(File.OpenRead("grant-letter-signed.pdf")), "file", "grant-letter-signed.pdf"); form.Add(new StringContent("grant-letter-signed.pdf"), "filename"); form.Add(new StringContent("Signed copy received 21 Sep"), "notes"); form.Add(new StringContent("8"), "filedefinitionid"); form.Add(new StringContent("Receipts"), "filecategory"); var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/buildings/104/attachments") { Content = form }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();