Leases
Lease agreements.
The object#
| Field | Type | Description |
|---|---|---|
| idread-only | integer | NolaPro id. |
| unitid | integer | Unitid. Id only. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| userid | integer | Userid. Id only. |
| user | string(50) | The name of the referenced genusers, instead of the id. Send this or userid, not both unless they agree. |
| rentperiod | string(5) | Rent Period: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly. |
| cotenant | string(150) | Co-tenant named on the lease. |
| cotenantemail | string(200) | Email of the co-tenant. |
| begindate | string | Date the lease begins. |
| enddate | string | Date the lease ends. |
| moveindate | string | Date the tenant moves in. |
| firstinvoicemonths | integer | Months before the move-in date that the first invoice comes due; copied from the building default. |
| origenddate | string | Original end date before any renewal or extension. |
| rentamountmoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| lawncaremoney | string(6dp) | Stored as decimal(19,6). |
| revenueglaccountid | integer | Reference to glaccounts, by id. Write either this or revenueglaccount. |
| revenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or revenueglaccountid, not both unless they agree. |
| petrentglaccountid | integer | Reference to glaccounts, by id. Write either this or petrentglaccount. |
| petrentglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petrentglaccountid, not both unless they agree. |
| lawncareglaccountid | integer | Reference to glaccounts, by id. Write either this or lawncareglaccount. |
| lawncareglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or lawncareglaccountid, not both unless they agree. |
| deferredrevenueglaccountid | integer | Reference to glaccounts, by id. Write either this or deferredrevenueglaccount. |
| deferredrevenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or deferredrevenueglaccountid, not both unless they agree. |
| numpayments | integer | Number of rent payments over the lease term, derived from the rent period (e.g. 12 for monthly). |
| depositamountmoney | string(6dp) | Stored as decimal(19,6). |
| depositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedinvoiceid | integer | Invoice the returned deposit was credited on. Write either this or depositreturnedinvoice. |
| depositreturnedinvoice | string(30) | Invoice NUMBER (arinvoice.invoicenumber) instead of the id. The sibling of depositreturnedinvoiceid. |
| depositkeptvoucherid | integer | Depositkeptvoucherid. Id only. |
| depositkeptvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or depositkeptvoucherid, not both unless they agree. |
| depositglaccountid | integer | Reference to glaccounts, by id. Write either this or depositglaccount. |
| depositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or depositglaccountid, not both unless they agree. |
| overagecapmoney | string(6dp) | Stored as decimal(19,6). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| notes | text | Notes. Stored as text, no practical length limit. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| reservationfeemoney | string(6dp) | Stored as decimal(19,6). |
| reservationfeeglaccountid | integer | Reference to glaccounts, by id. Write either this or reservationfeeglaccount. |
| reservationfeeglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or reservationfeeglaccountid, not both unless they agree. |
| petdepositmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositglaccountid | integer | Reference to glaccounts, by id. Write either this or petdepositglaccount. |
| petdepositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petdepositglaccountid, not both unless they agree. |
| petdepositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| proratedamountmoney | string(6dp) | Stored as decimal(19,6). |
| prorateddays | integer | Days of prorated rent billed for a partial first period. |
| proratedtotaldays | integer | Total days in the period the proration was computed against. |
| paymentplan | text | Paymentplan. Stored as text, no practical length limit. |
| leaseended | integer | 1 once the lease has ended. |
| leaseendeddate | string | Date the lease actually ended. |
| leaseendeduserid | integer | Reference to genusers, by id. Write either this or leaseendeduser. |
| leaseendeduser | string(50) | The name of the referenced genusers, instead of the id. Send this or leaseendeduserid, not both unless they agree. |
| origleaseid | integer | Origleaseid. Id only. |
| renewed | integer | 1 when the lease was renewed into a newer lease. |
| transferred | integer | 1 when the lease was transferred to another unit or tenant. |
| transferredunitid | integer | Transferredunitid. Id only. |
| autobill | integer | 1 generates rent invoices automatically each period (Auto Bill). |
| leasecode | string(30) | Short code identifying the lease. |
| signed | integer | 1 once the signed lease is on file; unsigned leases are flagged on lease lists. |
| prepaymentamountmoney | string(6dp) | Stored as decimal(19,6). |
| prepaymentdate | string | Date the prepayment (e.g. deposit or first rent) was received. |
| cotenant2 | string(150) | Second co-tenant named on the lease. |
| cotenant2email | string(200) | Email of the second co-tenant. |
| 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. |
| unitid | integer | Unitid. Id only. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| userid | integer | Userid. Id only. |
| user | string(50) | The name of the referenced genusers, instead of the id. Send this or userid, not both unless they agree. |
| rentperiod | string(5) | Rent Period: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly. |
| cotenant | string(150) | Co-tenant named on the lease. |
| cotenantemail | string(200) | Email of the co-tenant. |
| begindate | string | Date the lease begins. |
| enddate | string | Date the lease ends. |
| moveindate | string | Date the tenant moves in. |
| firstinvoicemonths | integer | Months before the move-in date that the first invoice comes due; copied from the building default. |
| origenddate | string | Original end date before any renewal or extension. |
| rentamountmoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| lawncaremoney | string(6dp) | Stored as decimal(19,6). |
| revenueglaccountid | integer | Reference to glaccounts, by id. Write either this or revenueglaccount. |
| revenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or revenueglaccountid, not both unless they agree. |
| petrentglaccountid | integer | Reference to glaccounts, by id. Write either this or petrentglaccount. |
| petrentglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petrentglaccountid, not both unless they agree. |
| lawncareglaccountid | integer | Reference to glaccounts, by id. Write either this or lawncareglaccount. |
| lawncareglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or lawncareglaccountid, not both unless they agree. |
| deferredrevenueglaccountid | integer | Reference to glaccounts, by id. Write either this or deferredrevenueglaccount. |
| deferredrevenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or deferredrevenueglaccountid, not both unless they agree. |
| numpayments | integer | Number of rent payments over the lease term, derived from the rent period (e.g. 12 for monthly). |
| depositamountmoney | string(6dp) | Stored as decimal(19,6). |
| depositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedinvoiceid | integer | Invoice the returned deposit was credited on. Write either this or depositreturnedinvoice. |
| depositreturnedinvoice | string(30) | Invoice NUMBER (arinvoice.invoicenumber) instead of the id. The sibling of depositreturnedinvoiceid. |
| depositkeptvoucherid | integer | Depositkeptvoucherid. Id only. |
| depositkeptvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or depositkeptvoucherid, not both unless they agree. |
| depositglaccountid | integer | Reference to glaccounts, by id. Write either this or depositglaccount. |
| depositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or depositglaccountid, not both unless they agree. |
| overagecapmoney | string(6dp) | Stored as decimal(19,6). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| notes | text | Notes. Stored as text, no practical length limit. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| reservationfeemoney | string(6dp) | Stored as decimal(19,6). |
| reservationfeeglaccountid | integer | Reference to glaccounts, by id. Write either this or reservationfeeglaccount. |
| reservationfeeglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or reservationfeeglaccountid, not both unless they agree. |
| petdepositmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositglaccountid | integer | Reference to glaccounts, by id. Write either this or petdepositglaccount. |
| petdepositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petdepositglaccountid, not both unless they agree. |
| petdepositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| proratedamountmoney | string(6dp) | Stored as decimal(19,6). |
| prorateddays | integer | Days of prorated rent billed for a partial first period. |
| proratedtotaldays | integer | Total days in the period the proration was computed against. |
| paymentplan | text | Paymentplan. Stored as text, no practical length limit. |
| leaseended | integer | 1 once the lease has ended. |
| leaseendeddate | string | Date the lease actually ended. |
| leaseendeduserid | integer | Reference to genusers, by id. Write either this or leaseendeduser. |
| leaseendeduser | string(50) | The name of the referenced genusers, instead of the id. Send this or leaseendeduserid, not both unless they agree. |
| origleaseid | integer | Origleaseid. Id only. |
| renewed | integer | 1 when the lease was renewed into a newer lease. |
| transferred | integer | 1 when the lease was transferred to another unit or tenant. |
| transferredunitid | integer | Transferredunitid. Id only. |
| autobill | integer | 1 generates rent invoices automatically each period (Auto Bill). |
| leasecode | string(30) | Short code identifying the lease. |
| signed | integer | 1 once the signed lease is on file; unsigned leases are flagged on lease lists. |
| prepaymentamountmoney | string(6dp) | Stored as decimal(19,6). |
| prepaymentdate | string | Date the prepayment (e.g. deposit or first rent) was received. |
| cotenant2 | string(150) | Second co-tenant named on the lease. |
| cotenant2email | string(200) | Email of the second co-tenant. |
| externalid | string(100) | Your own key. Scoped to your company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/leases/batch' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '[ { "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant" } ]'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases/batch'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ [ 'unitid' => 104, 'customerid' => 104, 'customer' => 'Example customer', 'user' => 'Example user', 'rentperiod' => 'Example rentperiod', 'cotenant' => 'Example cotenant', ], ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/leases/batch", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json=[ { "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant", }, ], ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases/batch', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify([ { unitid: 104, customerid: 104, customer: "Example customer", user: "Example user", rentperiod: "Example rentperiod", cotenant: "Example cotenant", }, ]), } ); 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 { unitid = 104, customerid = 104, customer = "Example customer", user = "Example user", rentperiod = "Example rentperiod", cotenant = "Example cotenant", }, }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/leases/batch") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
List leases.
Requires scope properties:read.
| Name | In | Type | Notes |
|---|---|---|---|
| customerid | query | string | Restrict to one customerid. |
| 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/leases' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases'); 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/leases", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases', { 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/leases"); 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. |
| unitid | integer | Unitid. Id only. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| userid | integer | Userid. Id only. |
| user | string(50) | The name of the referenced genusers, instead of the id. Send this or userid, not both unless they agree. |
| rentperiod | string(5) | Rent Period: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly. |
| cotenant | string(150) | Co-tenant named on the lease. |
| cotenantemail | string(200) | Email of the co-tenant. |
| begindate | string | Date the lease begins. |
| enddate | string | Date the lease ends. |
| moveindate | string | Date the tenant moves in. |
| firstinvoicemonths | integer | Months before the move-in date that the first invoice comes due; copied from the building default. |
| origenddate | string | Original end date before any renewal or extension. |
| rentamountmoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| lawncaremoney | string(6dp) | Stored as decimal(19,6). |
| revenueglaccountid | integer | Reference to glaccounts, by id. Write either this or revenueglaccount. |
| revenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or revenueglaccountid, not both unless they agree. |
| petrentglaccountid | integer | Reference to glaccounts, by id. Write either this or petrentglaccount. |
| petrentglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petrentglaccountid, not both unless they agree. |
| lawncareglaccountid | integer | Reference to glaccounts, by id. Write either this or lawncareglaccount. |
| lawncareglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or lawncareglaccountid, not both unless they agree. |
| deferredrevenueglaccountid | integer | Reference to glaccounts, by id. Write either this or deferredrevenueglaccount. |
| deferredrevenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or deferredrevenueglaccountid, not both unless they agree. |
| numpayments | integer | Number of rent payments over the lease term, derived from the rent period (e.g. 12 for monthly). |
| depositamountmoney | string(6dp) | Stored as decimal(19,6). |
| depositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedinvoiceid | integer | Invoice the returned deposit was credited on. Write either this or depositreturnedinvoice. |
| depositreturnedinvoice | string(30) | Invoice NUMBER (arinvoice.invoicenumber) instead of the id. The sibling of depositreturnedinvoiceid. |
| depositkeptvoucherid | integer | Depositkeptvoucherid. Id only. |
| depositkeptvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or depositkeptvoucherid, not both unless they agree. |
| depositglaccountid | integer | Reference to glaccounts, by id. Write either this or depositglaccount. |
| depositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or depositglaccountid, not both unless they agree. |
| overagecapmoney | string(6dp) | Stored as decimal(19,6). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| notes | text | Notes. Stored as text, no practical length limit. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| reservationfeemoney | string(6dp) | Stored as decimal(19,6). |
| reservationfeeglaccountid | integer | Reference to glaccounts, by id. Write either this or reservationfeeglaccount. |
| reservationfeeglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or reservationfeeglaccountid, not both unless they agree. |
| petdepositmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositglaccountid | integer | Reference to glaccounts, by id. Write either this or petdepositglaccount. |
| petdepositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petdepositglaccountid, not both unless they agree. |
| petdepositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| proratedamountmoney | string(6dp) | Stored as decimal(19,6). |
| prorateddays | integer | Days of prorated rent billed for a partial first period. |
| proratedtotaldays | integer | Total days in the period the proration was computed against. |
| paymentplan | text | Paymentplan. Stored as text, no practical length limit. |
| leaseended | integer | 1 once the lease has ended. |
| leaseendeddate | string | Date the lease actually ended. |
| leaseendeduserid | integer | Reference to genusers, by id. Write either this or leaseendeduser. |
| leaseendeduser | string(50) | The name of the referenced genusers, instead of the id. Send this or leaseendeduserid, not both unless they agree. |
| origleaseid | integer | Origleaseid. Id only. |
| renewed | integer | 1 when the lease was renewed into a newer lease. |
| transferred | integer | 1 when the lease was transferred to another unit or tenant. |
| transferredunitid | integer | Transferredunitid. Id only. |
| autobill | integer | 1 generates rent invoices automatically each period (Auto Bill). |
| leasecode | string(30) | Short code identifying the lease. |
| signed | integer | 1 once the signed lease is on file; unsigned leases are flagged on lease lists. |
| prepaymentamountmoney | string(6dp) | Stored as decimal(19,6). |
| prepaymentdate | string | Date the prepayment (e.g. deposit or first rent) was received. |
| cotenant2 | string(150) | Second co-tenant named on the lease. |
| cotenant2email | string(200) | Email of the second co-tenant. |
| 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/leases' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_POSTFIELDS => json_encode([ 'unitid' => 104, 'customerid' => 104, 'customer' => 'Example customer', 'user' => 'Example user', 'rentperiod' => 'Example rentperiod', 'cotenant' => 'Example cotenant', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.post( "https://acme.nolapro.com/!/api/v2/leases", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases', { method: 'POST', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ unitid: 104, customerid: 104, customer: "Example customer", user: "Example user", rentperiod: "Example rentperiod", cotenant: "Example cotenant", }), } ); 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 { unitid = 104, customerid = 104, customer = "Example customer", user = "Example user", rentperiod = "Example rentperiod", cotenant = "Example cotenant", }; var req = new HttpRequestMessage(HttpMethod.Post, "https://acme.nolapro.com/!/api/v2/leases") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"unitid": 104,
"customerid": 104,
"customer": "Example customer",
"user": "Example user",
"rentperiod": "Example rentperiod",
"cotenant": "Example cotenant"
}
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/leases/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases/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/leases/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases/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/leases/104"); res.EnsureSuccessStatusCode();
{
"unitid": 104,
"customerid": 104,
"customer": "Example customer",
"user": "Example user",
"rentperiod": "Example rentperiod",
"cotenant": "Example cotenant"
}
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. |
| unitid | integer | Unitid. Id only. |
| customerid | integer | Reference to customers, by id. Write either this or customer. |
| customer | string(30) | Code for the referenced customer, instead of the id. |
| userid | integer | Userid. Id only. |
| user | string(50) | The name of the referenced genusers, instead of the id. Send this or userid, not both unless they agree. |
| rentperiod | string(5) | Rent Period: W = weekly, SM = semi-monthly, M = monthly, S = semester, SY = semi-yearly, AY = academic year, Y = yearly. |
| cotenant | string(150) | Co-tenant named on the lease. |
| cotenantemail | string(200) | Email of the co-tenant. |
| begindate | string | Date the lease begins. |
| enddate | string | Date the lease ends. |
| moveindate | string | Date the tenant moves in. |
| firstinvoicemonths | integer | Months before the move-in date that the first invoice comes due; copied from the building default. |
| origenddate | string | Original end date before any renewal or extension. |
| rentamountmoney | string(6dp) | Stored as decimal(19,6). |
| petrentmoney | string(6dp) | Stored as decimal(19,6). |
| lawncaremoney | string(6dp) | Stored as decimal(19,6). |
| revenueglaccountid | integer | Reference to glaccounts, by id. Write either this or revenueglaccount. |
| revenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or revenueglaccountid, not both unless they agree. |
| petrentglaccountid | integer | Reference to glaccounts, by id. Write either this or petrentglaccount. |
| petrentglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petrentglaccountid, not both unless they agree. |
| lawncareglaccountid | integer | Reference to glaccounts, by id. Write either this or lawncareglaccount. |
| lawncareglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or lawncareglaccountid, not both unless they agree. |
| deferredrevenueglaccountid | integer | Reference to glaccounts, by id. Write either this or deferredrevenueglaccount. |
| deferredrevenueglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or deferredrevenueglaccountid, not both unless they agree. |
| numpayments | integer | Number of rent payments over the lease term, derived from the rent period (e.g. 12 for monthly). |
| depositamountmoney | string(6dp) | Stored as decimal(19,6). |
| depositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| depositreturnedinvoiceid | integer | Invoice the returned deposit was credited on. Write either this or depositreturnedinvoice. |
| depositreturnedinvoice | string(30) | Invoice NUMBER (arinvoice.invoicenumber) instead of the id. The sibling of depositreturnedinvoiceid. |
| depositkeptvoucherid | integer | Depositkeptvoucherid. Id only. |
| depositkeptvoucher | string(50) | The voucher of the referenced gltransactions, instead of the id. Send this or depositkeptvoucherid, not both unless they agree. |
| depositglaccountid | integer | Reference to glaccounts, by id. Write either this or depositglaccount. |
| depositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or depositglaccountid, not both unless they agree. |
| overagecapmoney | string(6dp) | Stored as decimal(19,6). |
| latefeemoney | string(6dp) | Stored as decimal(19,6). |
| transferfeemoney | string(6dp) | Stored as decimal(19,6). |
| notes | text | Notes. Stored as text, no practical length limit. |
| entrydateread-only | string | When the record was created. |
| cancel | boolean | Cancelled. Always a boolean on the wire, whatever integer width the column uses (D23). |
| reservationfeemoney | string(6dp) | Stored as decimal(19,6). |
| reservationfeeglaccountid | integer | Reference to glaccounts, by id. Write either this or reservationfeeglaccount. |
| reservationfeeglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or reservationfeeglaccountid, not both unless they agree. |
| petdepositmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositcreditmoney | string(6dp) | Stored as decimal(19,6). |
| petdepositglaccountid | integer | Reference to glaccounts, by id. Write either this or petdepositglaccount. |
| petdepositglaccount | string(20) | The name of the referenced glaccounts, instead of the id. Send this or petdepositglaccountid, not both unless they agree. |
| petdepositreturnedmoney | string(6dp) | Stored as decimal(19,6). |
| proratedamountmoney | string(6dp) | Stored as decimal(19,6). |
| prorateddays | integer | Days of prorated rent billed for a partial first period. |
| proratedtotaldays | integer | Total days in the period the proration was computed against. |
| paymentplan | text | Paymentplan. Stored as text, no practical length limit. |
| leaseended | integer | 1 once the lease has ended. |
| leaseendeddate | string | Date the lease actually ended. |
| leaseendeduserid | integer | Reference to genusers, by id. Write either this or leaseendeduser. |
| leaseendeduser | string(50) | The name of the referenced genusers, instead of the id. Send this or leaseendeduserid, not both unless they agree. |
| origleaseid | integer | Origleaseid. Id only. |
| renewed | integer | 1 when the lease was renewed into a newer lease. |
| transferred | integer | 1 when the lease was transferred to another unit or tenant. |
| transferredunitid | integer | Transferredunitid. Id only. |
| autobill | integer | 1 generates rent invoices automatically each period (Auto Bill). |
| leasecode | string(30) | Short code identifying the lease. |
| signed | integer | 1 once the signed lease is on file; unsigned leases are flagged on lease lists. |
| prepaymentamountmoney | string(6dp) | Stored as decimal(19,6). |
| prepaymentdate | string | Date the prepayment (e.g. deposit or first rent) was received. |
| cotenant2 | string(150) | Second co-tenant named on the lease. |
| cotenant2email | string(200) | Email of the second co-tenant. |
| 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/leases/104' \ -H 'Authorization: Bearer $NP_TOKEN' \ -H 'Content-Type: application/json' \ -H 'Idempotency-Key: your-unique-key' \ -d '{ "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant" }'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases/104'); curl_setopt_array($ch, [ CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('NP_TOKEN')], CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'PATCH', CURLOPT_POSTFIELDS => json_encode([ 'unitid' => 104, 'customerid' => 104, 'customer' => 'Example customer', 'user' => 'Example user', 'rentperiod' => 'Example rentperiod', 'cotenant' => 'Example cotenant', ]), ]); $res = json_decode(curl_exec($ch), true);
import os, requests r = requests.patch( "https://acme.nolapro.com/!/api/v2/leases/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, json={ "unitid": 104, "customerid": 104, "customer": "Example customer", "user": "Example user", "rentperiod": "Example rentperiod", "cotenant": "Example cotenant", }, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases/104', { method: 'PATCH', headers: { Authorization: `Bearer ${process.env.NP_TOKEN}` }, body: JSON.stringify({ unitid: 104, customerid: 104, customer: "Example customer", user: "Example user", rentperiod: "Example rentperiod", cotenant: "Example cotenant", }), } ); 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 { unitid = 104, customerid = 104, customer = "Example customer", user = "Example user", rentperiod = "Example rentperiod", cotenant = "Example cotenant", }; var req = new HttpRequestMessage(HttpMethod.Patch, "https://acme.nolapro.com/!/api/v2/leases/104") { Content = JsonContent.Create(body), }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"unitid": 104,
"customerid": 104,
"customer": "Example customer",
"user": "Example user",
"rentperiod": "Example rentperiod",
"cotenant": "Example cotenant"
}
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/leases/104' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases/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/leases/104", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases/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/leases/104"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();
{
"unitid": 104,
"customerid": 104,
"customer": "Example customer",
"user": "Example user",
"rentperiod": "Example rentperiod",
"cotenant": "Example cotenant"
}
List files attached to a lease.
The attachments on this lease, newest first. Accepted filedefinitionid values: 32 (default 32). Metadata only - each file's bytes are at GET /attachments/{id}/content.
Requires scope properties:read.
| Name | In | Type | Notes |
|---|---|---|---|
| idrequired | path | integer | The lease id. |
| filedefinitionid | query | integer | Only files in this list. Accepted filedefinitionid values: 32 (default 32). |
| 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 lease with that id in this company. |
curl \ 'https://acme.nolapro.com/!/api/v2/leases/104/attachments' \ -H 'Authorization: Bearer $NP_TOKEN'
$ch = curl_init('https://acme.nolapro.com/!/api/v2/leases/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/leases/104/attachments", headers={"Authorization": f"Bearer {os.environ['NP_TOKEN']}"}, ) r.raise_for_status()
const res = await fetch( 'https://acme.nolapro.com/!/api/v2/leases/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/leases/104/attachments"); res.EnsureSuccessStatusCode();
Attach a file to a lease.
multipart/form-data with one file part; see the AttachmentUpload schema for the other parts. Accepted filedefinitionid values: 32 (default 32). 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 lease 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 lease with that id in this company. |
| 409 | upload_limit_reached | This file list allows a fixed number of files on a lease 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 lease accepts, or the category does not exist in this company. |
curl -X POST \ 'https://acme.nolapro.com/!/api/v2/leases/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/leases/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/leases/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/leases/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/leases/104/attachments") { Content = form }; req.Headers.Add("Idempotency-Key", "your-unique-key"); var res = await http.SendAsync(req); res.EnsureSuccessStatusCode();