Buildings

Buildings that rentable units belong to.

The object#

FieldTypeDescription
idread-onlyintegerNolaPro id.
codestring(20)Short code identifying the building.
namestring(100)Building name.
address1string(100)Street address.
address2string(100)Second address line.
citystring(50)City of the building address.
statestring(20)State of the building address.
zipstring(15)Postal code.
descriptiontextDescription. Stored as text, no practical length limit.
managementfeemoneystring(2dp)Stored as decimal(6,2).
latefeemoneystring(6dp)Stored as decimal(19,6).
transferfeemoneystring(6dp)Stored as decimal(19,6).
petrentmoneystring(6dp)Stored as decimal(19,6).
utilitieschargestring(5)How tenant utilities are billed: A = all usage, O = overage over the cap only.
electricbasismoneystring(6dp)Stored as decimal(19,6).
waterbasismoneystring(6dp)Stored as decimal(19,6).
gasbasismoneystring(6dp)Stored as decimal(19,6).
buildingtypeidintegerBuildingtypeid. Id only.
entrydateread-onlystringWhen the record was created.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
areaidintegerReference to areas, by id. Write either this or area.
areastring(100)The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree.
firstnoticeintegerDays past due before the first late notice is sent.
secondnoticeintegerDays past due before the second late notice is sent.
finalnoticeintegerDays past due before the final late notice is sent.
asleasetemplateidstring(45)E-signature template id for the lease agreement, 3-signer variant.
asleasetemplateid2string(45)E-signature template id for the lease agreement, 2-signer variant.
asleasedocnamestring(100)Document name given to the lease agreement when it is sent for e-signature.
docexpirationdaysintegerDays until an e-signature request for this building’s documents expires.
asguarantordocnamestring(100)Document name given to the guarantor agreement when it is sent for e-signature.
asguarantortemplateidstring(45)E-signature template id for the guarantor agreement.
aspetdocnamestring(100)Document name given to the pet agreement when it is sent for e-signature.
aspettemplateidstring(45)E-signature template id for the pet agreement.
asterminationdocnamestring(100)Document name given to the termination document when it is sent for e-signature.
asterminationtemplateidstring(45)E-signature template id for the lease termination, 3-signer variant.
asterminationtemplateid2string(45)E-signature template id for the lease termination, 2-signer variant.
firstinvoicemonthsintegerMonths before the move-in date that the first lease invoice comes due (0-11).
asamendmenttemplateidstring(45)E-signature template id for a lease amendment.
asamendmentdocnamestring(100)Document name given to the amendment when it is sent for e-signature.
asleasetemplateid4string(45)E-signature template id for the lease agreement, 4-signer variant.
addressverifiedread-onlystring(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.
externalidstring(100)Your own key. Scoped to your company.

Endpoints#

POST/buildings/batch 207

Create many.

Requires scope properties:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes 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.
Body array
FieldTypeDescription
idread-onlyintegerNolaPro id.
codestring(20)Short code identifying the building.
namestring(100)Building name.
address1string(100)Street address.
address2string(100)Second address line.
citystring(50)City of the building address.
statestring(20)State of the building address.
zipstring(15)Postal code.
descriptiontextDescription. Stored as text, no practical length limit.
managementfeemoneystring(2dp)Stored as decimal(6,2).
latefeemoneystring(6dp)Stored as decimal(19,6).
transferfeemoneystring(6dp)Stored as decimal(19,6).
petrentmoneystring(6dp)Stored as decimal(19,6).
utilitieschargestring(5)How tenant utilities are billed: A = all usage, O = overage over the cap only.
electricbasismoneystring(6dp)Stored as decimal(19,6).
waterbasismoneystring(6dp)Stored as decimal(19,6).
gasbasismoneystring(6dp)Stored as decimal(19,6).
buildingtypeidintegerBuildingtypeid. Id only.
entrydateread-onlystringWhen the record was created.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
areaidintegerReference to areas, by id. Write either this or area.
areastring(100)The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree.
firstnoticeintegerDays past due before the first late notice is sent.
secondnoticeintegerDays past due before the second late notice is sent.
finalnoticeintegerDays past due before the final late notice is sent.
asleasetemplateidstring(45)E-signature template id for the lease agreement, 3-signer variant.
asleasetemplateid2string(45)E-signature template id for the lease agreement, 2-signer variant.
asleasedocnamestring(100)Document name given to the lease agreement when it is sent for e-signature.
docexpirationdaysintegerDays until an e-signature request for this building’s documents expires.
asguarantordocnamestring(100)Document name given to the guarantor agreement when it is sent for e-signature.
asguarantortemplateidstring(45)E-signature template id for the guarantor agreement.
aspetdocnamestring(100)Document name given to the pet agreement when it is sent for e-signature.
aspettemplateidstring(45)E-signature template id for the pet agreement.
asterminationdocnamestring(100)Document name given to the termination document when it is sent for e-signature.
asterminationtemplateidstring(45)E-signature template id for the lease termination, 3-signer variant.
asterminationtemplateid2string(45)E-signature template id for the lease termination, 2-signer variant.
firstinvoicemonthsintegerMonths before the move-in date that the first lease invoice comes due (0-11).
asamendmenttemplateidstring(45)E-signature template id for a lease amendment.
asamendmentdocnamestring(100)Document name given to the amendment when it is sent for e-signature.
asleasetemplateid4string(45)E-signature template id for the lease agreement, 4-signer variant.
addressverifiedread-onlystring(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.
externalidstring(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"
    }
]'
GET/buildings 200403

List buildings.

Requires scope properties:read.

Parameters
NameInTypeNotes
descriptionquerystringdescription. Partial match, case-insensitive.
codequerystringcode. Partial match, case-insensitive.
namequerystringPartial match, case insensitive.
cancelquerystringDefaults to false. Pass true or any.
externalidquerystringExact match on your own key.
includequerystringComma-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
StatusCodeMeaning
403insufficient_scopeToken lacks read scope.
curl \
  'https://acme.nolapro.com/!/api/v2/buildings' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/buildings 201400

Create.

Requires scope properties:write.

Parameters
NameInTypeNotes
Idempotency-KeyheaderstringMakes 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.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
codestring(20)Short code identifying the building.
namestring(100)Building name.
address1string(100)Street address.
address2string(100)Second address line.
citystring(50)City of the building address.
statestring(20)State of the building address.
zipstring(15)Postal code.
descriptiontextDescription. Stored as text, no practical length limit.
managementfeemoneystring(2dp)Stored as decimal(6,2).
latefeemoneystring(6dp)Stored as decimal(19,6).
transferfeemoneystring(6dp)Stored as decimal(19,6).
petrentmoneystring(6dp)Stored as decimal(19,6).
utilitieschargestring(5)How tenant utilities are billed: A = all usage, O = overage over the cap only.
electricbasismoneystring(6dp)Stored as decimal(19,6).
waterbasismoneystring(6dp)Stored as decimal(19,6).
gasbasismoneystring(6dp)Stored as decimal(19,6).
buildingtypeidintegerBuildingtypeid. Id only.
entrydateread-onlystringWhen the record was created.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
areaidintegerReference to areas, by id. Write either this or area.
areastring(100)The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree.
firstnoticeintegerDays past due before the first late notice is sent.
secondnoticeintegerDays past due before the second late notice is sent.
finalnoticeintegerDays past due before the final late notice is sent.
asleasetemplateidstring(45)E-signature template id for the lease agreement, 3-signer variant.
asleasetemplateid2string(45)E-signature template id for the lease agreement, 2-signer variant.
asleasedocnamestring(100)Document name given to the lease agreement when it is sent for e-signature.
docexpirationdaysintegerDays until an e-signature request for this building’s documents expires.
asguarantordocnamestring(100)Document name given to the guarantor agreement when it is sent for e-signature.
asguarantortemplateidstring(45)E-signature template id for the guarantor agreement.
aspetdocnamestring(100)Document name given to the pet agreement when it is sent for e-signature.
aspettemplateidstring(45)E-signature template id for the pet agreement.
asterminationdocnamestring(100)Document name given to the termination document when it is sent for e-signature.
asterminationtemplateidstring(45)E-signature template id for the lease termination, 3-signer variant.
asterminationtemplateid2string(45)E-signature template id for the lease termination, 2-signer variant.
firstinvoicemonthsintegerMonths before the move-in date that the first lease invoice comes due (0-11).
asamendmenttemplateidstring(45)E-signature template id for a lease amendment.
asamendmentdocnamestring(100)Document name given to the amendment when it is sent for e-signature.
asleasetemplateid4string(45)E-signature template id for the lease agreement, 4-signer variant.
addressverifiedread-onlystring(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.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
400invalid_requestA 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"
}'
Response 201
{
    "code": "ACME-01",
    "name": "Example name",
    "address1": "Example address1",
    "address2": "Example address2",
    "city": "Example city",
    "state": "Example state"
}
GET/buildings/{id} 200404

Retrieve one record.

Requires scope properties:read.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
includequerystringComma-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
StatusCodeMeaning
404not_foundNo record with that id.
curl \
  'https://acme.nolapro.com/!/api/v2/buildings/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "code": "ACME-01",
    "name": "Example name",
    "address1": "Example address1",
    "address2": "Example address2",
    "city": "Example city",
    "state": "Example state"
}
PATCH/buildings/{id} 200404

Update.

Requires scope properties:write.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes 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.
Body
FieldTypeDescription
idread-onlyintegerNolaPro id.
codestring(20)Short code identifying the building.
namestring(100)Building name.
address1string(100)Street address.
address2string(100)Second address line.
citystring(50)City of the building address.
statestring(20)State of the building address.
zipstring(15)Postal code.
descriptiontextDescription. Stored as text, no practical length limit.
managementfeemoneystring(2dp)Stored as decimal(6,2).
latefeemoneystring(6dp)Stored as decimal(19,6).
transferfeemoneystring(6dp)Stored as decimal(19,6).
petrentmoneystring(6dp)Stored as decimal(19,6).
utilitieschargestring(5)How tenant utilities are billed: A = all usage, O = overage over the cap only.
electricbasismoneystring(6dp)Stored as decimal(19,6).
waterbasismoneystring(6dp)Stored as decimal(19,6).
gasbasismoneystring(6dp)Stored as decimal(19,6).
buildingtypeidintegerBuildingtypeid. Id only.
entrydateread-onlystringWhen the record was created.
cancelbooleanCancelled. Always a boolean on the wire, whatever integer width the column uses (D23).
areaidintegerReference to areas, by id. Write either this or area.
areastring(100)The name of the referenced areas, instead of the id. Send this or areaid, not both unless they agree.
firstnoticeintegerDays past due before the first late notice is sent.
secondnoticeintegerDays past due before the second late notice is sent.
finalnoticeintegerDays past due before the final late notice is sent.
asleasetemplateidstring(45)E-signature template id for the lease agreement, 3-signer variant.
asleasetemplateid2string(45)E-signature template id for the lease agreement, 2-signer variant.
asleasedocnamestring(100)Document name given to the lease agreement when it is sent for e-signature.
docexpirationdaysintegerDays until an e-signature request for this building’s documents expires.
asguarantordocnamestring(100)Document name given to the guarantor agreement when it is sent for e-signature.
asguarantortemplateidstring(45)E-signature template id for the guarantor agreement.
aspetdocnamestring(100)Document name given to the pet agreement when it is sent for e-signature.
aspettemplateidstring(45)E-signature template id for the pet agreement.
asterminationdocnamestring(100)Document name given to the termination document when it is sent for e-signature.
asterminationtemplateidstring(45)E-signature template id for the lease termination, 3-signer variant.
asterminationtemplateid2string(45)E-signature template id for the lease termination, 2-signer variant.
firstinvoicemonthsintegerMonths before the move-in date that the first lease invoice comes due (0-11).
asamendmenttemplateidstring(45)E-signature template id for a lease amendment.
asamendmentdocnamestring(100)Document name given to the amendment when it is sent for e-signature.
asleasetemplateid4string(45)E-signature template id for the lease agreement, 4-signer variant.
addressverifiedread-onlystring(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.
externalidstring(100)Your own key. Scoped to your company.
When it fails
StatusCodeMeaning
404not_foundNo 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"
}'
Response 200
{
    "code": "ACME-01",
    "name": "Example name",
    "address1": "Example address1",
    "address2": "Example address2",
    "city": "Example city",
    "state": "Example state"
}
DELETE/buildings/{id} 200404

Cancel.

Requires scope properties:cancel.

Parameters
NameInTypeNotes
idrequiredpathintegerThe record id.
Idempotency-KeyheaderstringMakes 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.
When it fails
StatusCodeMeaning
404not_foundNo record with that id.
curl -X DELETE \
  'https://acme.nolapro.com/!/api/v2/buildings/104' \
  -H 'Authorization: Bearer $NP_TOKEN'
Response 200
{
    "code": "ACME-01",
    "name": "Example name",
    "address1": "Example address1",
    "address2": "Example address2",
    "city": "Example city",
    "state": "Example state"
}
GET/buildings/{id}/attachments 200404

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.

Parameters
NameInTypeNotes
idrequiredpathintegerThe building id.
filedefinitionidqueryintegerOnly files in this list. Accepted filedefinitionid values: 30, 28, 36 (default 30).
filecategoryidqueryintegerOnly files filed under this category.
filenamequerystringPartial match on the file name, case insensitive.
When it fails
StatusCodeMeaning
404not_foundNo building with that id in this company.
curl \
  'https://acme.nolapro.com/!/api/v2/buildings/104/attachments' \
  -H 'Authorization: Bearer $NP_TOKEN'
POST/buildings/{id}/attachments 201400404409413415422

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.

Parameters
NameInTypeNotes
idrequiredpathintegerThe building id.
Idempotency-KeyheaderstringMakes 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.
Body multipart/form-data
FieldTypeDescription
filerequiredstringThe 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.
filenamestring(255)Overrides the part's file name.
notestextFree text shown beside the file.
filedefinitionidintegerOnly when the parent accepts more than one list. Anything the parent does not accept is 422 unknown_value naming the accepted ids.
filecategoryidintegerCategory by id.
filecategorystring(255)Category by name. Sent with filecategoryid and disagreeing is 422 conflicting_reference.
When it fails
StatusCodeMeaning
400unknown_parameterA form field that is not on the AttachmentUpload schema.
400invalid_typefiledefinitionid or filecategoryid that is not an integer.
404not_foundNo building with that id in this company.
409upload_limit_reachedThis file list allows a fixed number of files on a building and it is full. Remove one first.
413payload_too_largeThe file is over the cap. The body names the limit that applied.
415multipart_requiredThe body was not multipart/form-data.
422unknown_valuefiledefinitionid 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'