REST API for NexusOne RE

Every HTTP endpoint the application exposes, grouped by resource.

Calling the API

The API is served from the same address as the application, under /api. Requests carry the session cookie issued at sign-in, so a browser session and an API call are the same identity and obey the same permissions.

Every state changing request (POST, PUT, PATCH, DELETE) must also carry this application family's presence header, or it is refused with 403 bad request. That refusal reads like a permissions fault but is not one. Integration and APIs lists the header per family.

Endpoints

155 endpoints in 55 resource groups.

accounts · activity · alerts · applications · automation · bank · budgets · collections · compliance · connect · custom-domain · dashboard · fin · findash · fixed-assets · gl · invoices · journals · leases · ledger · login · logout · maintenance · next-number · nxdocs · nxdocs-file · nxtz · owner-disbursements · owner-statement · password · pay · payments · perms · pm-pos · portal · projects · properties · renew · renewals · rentroll · reports · search · sender-domains · sender-emails · sender-options · sender-prefs · session · settings · statements · tenant-docs · tenants · units · username · users · vendor-bills

accounts 3

Method	Path	Access
GET	`/api/accounts`	signed in
POST	`/api/accounts`	administrator
PUT	`/api/accounts/:id`	administrator

activity 1

Method	Path	Access
GET	`/api/activity`	administrator

alerts 2

Method	Path	Access
GET	`/api/alerts`	signed in
POST	`/api/alerts/:id/resolve`	signed in

applications 3

Method	Path	Access
GET	`/api/applications`	signed in
POST	`/api/applications/:id/decide`	signed in
POST	`/api/applications/:id/screen`	signed in

automation 3

Method	Path	Access
POST	`/api/automation/run`	administrator
GET	`/api/automation/status`	signed in
PUT	`/api/automation/toggles`	administrator

bank 8

Method	Path	Access
GET	`/api/bank/accounts`	signed in
POST	`/api/bank/accounts`	administrator
PUT	`/api/bank/accounts/:id`	administrator
POST	`/api/bank/reconcile`	signed in
GET	`/api/bank/reconciliation/:account_id`	signed in
GET	`/api/bank/txns`	signed in
POST	`/api/bank/txns`	signed in
GET	`/api/bank/unreconciled`	signed in

budgets 4

Method	Path	Access
GET	`/api/budgets`	signed in
POST	`/api/budgets`	administrator
DELETE	`/api/budgets/:id`	administrator
PUT	`/api/budgets/:id`	administrator

collections 1

Method	Path	Access
GET	`/api/collections`	signed in

compliance 1

Method	Path	Access
GET	`/api/compliance`	signed in

connect 25

Method	Path	Access
GET	`/api/connect/connections`	signed in
POST	`/api/connect/connections`	signed in
DELETE	`/api/connect/connections/:id`	signed in
PUT	`/api/connect/connections/:id`	signed in
POST	`/api/connect/connections/:id/call`	signed in
POST	`/api/connect/connections/:id/test`	signed in
GET	`/api/connect/hooks`	signed in
POST	`/api/connect/hooks`	signed in
DELETE	`/api/connect/hooks/:id`	signed in
PUT	`/api/connect/hooks/:id`	signed in
GET	`/api/connect/hooks/:id/events`	signed in
GET	`/api/connect/log`	signed in
GET	`/api/connect/meta`	signed in
GET	`/api/connect/subs`	signed in
POST	`/api/connect/subs`	signed in
DELETE	`/api/connect/subs/:id`	signed in
PUT	`/api/connect/subs/:id`	signed in
POST	`/api/connect/subs/:id/test`	administrator
GET	`/api/connect/tokens`	signed in
POST	`/api/connect/tokens`	signed in
DELETE	`/api/connect/tokens/:id`	signed in
PUT	`/api/connect/tokens/:id`	signed in
POST	`/connect/hook/:slug`	signed in
GET	`/connect/mcp`	signed in
POST	`/connect/mcp`	signed in

custom-domain 3

Method	Path	Access
GET	`/api/custom-domain`	signed in
PUT	`/api/custom-domain`	signed in
POST	`/api/custom-domain/verify`	signed in

dashboard 1

Method	Path	Access
GET	`/api/dashboard`	signed in

fin 5

Method	Path	Access
GET	`/api/fin/balance-sheet`	signed in
GET	`/api/fin/cashflow`	signed in
GET	`/api/fin/dashboard`	signed in
GET	`/api/fin/pnl`	signed in
GET	`/api/fin/trial-balance`	signed in

findash 1

Method	Path	Access
GET	`/api/findash`	signed in

fixed-assets 3

Method	Path	Access
GET	`/api/fixed-assets`	signed in
POST	`/api/fixed-assets`	administrator
POST	`/api/fixed-assets/depreciate`	administrator

gl 1

Method	Path	Access
POST	`/api/gl/rebuild`	administrator

invoices 2

Method	Path	Access
GET	`/api/invoices`	signed in
POST	`/api/invoices`	signed in

journals 3

Method	Path	Access
GET	`/api/journals`	signed in
POST	`/api/journals`	administrator
GET	`/api/journals/:id`	signed in

leases 3

Method	Path	Access
GET	`/api/leases`	signed in
POST	`/api/leases`	signed in
POST	`/api/leases/:id/end`	signed in

ledger 2

Method	Path	Access
GET	`/api/ledger`	signed in
POST	`/api/ledger`	signed in

Method	Path	Access
POST	`/api/login`	public
POST	`/api/login/2fa`	public

logout 1

Method	Path	Access
POST	`/api/logout`	signed in

maintenance 3

Method	Path	Access
GET	`/api/maintenance`	signed in
POST	`/api/maintenance`	signed in
PUT	`/api/maintenance/:id`	signed in

next-number 1

Method	Path	Access
GET	`/api/next-number`	signed in

nxdocs 2

Method	Path	Access
GET	`/api/nxdocs/:kind/:ref`	signed in
POST	`/api/nxdocs/:kind/:ref`	signed in

nxdocs-file 2

Method	Path	Access
DELETE	`/api/nxdocs-file/:id`	signed in
GET	`/api/nxdocs-file/:id`	signed in

nxtz 3

Method	Path	Access
GET	`/api/nxtz`	signed in
PUT	`/api/nxtz`	signed in
POST	`/api/nxtz/device`	signed in

owner-disbursements 3

Method	Path	Access
GET	`/api/owner-disbursements`	signed in
POST	`/api/owner-disbursements`	administrator
POST	`/api/owner-disbursements/:id/pay`	administrator

owner-statement 1

Method	Path	Access
GET	`/api/owner-statement/:owner_id`	signed in

password 2

Method	Path	Access
POST	`/api/password/forgot`	public
POST	`/api/password/reset`	signed in

pay 1

Method	Path	Access
POST	`/api/pay/webhook`	signed in

payments 5

Method	Path	Access
GET	`/api/payments`	signed in
POST	`/api/payments`	signed in
POST	`/api/payments/:id/reassign`	signed in
GET	`/api/payments/:id/receipt.pdf`	signed in
POST	`/api/payments/:id/void`	signed in

perms 2

Method	Path	Access
GET	`/api/perms/catalog`	signed in
GET	`/api/perms/resolved`	administrator

pm-pos 5

Method	Path	Access
GET	`/api/pm-pos`	signed in
POST	`/api/pm-pos`	signed in
GET	`/api/pm-pos/:id`	signed in
POST	`/api/pm-pos/:id/pay`	signed in
POST	`/api/pm-pos/:id/status`	signed in

portal 6

Method	Path	Access
GET	`/api/portal/doc/:id`	signed in
POST	`/api/portal/maintenance`	signed in
GET	`/api/portal/me`	signed in
GET	`/api/portal/receipt/:payment_id`	signed in
POST	`/api/portal/renewal/:id`	signed in
GET	`/api/portal/statement/:property_id`	signed in

projects 3

Method	Path	Access
GET	`/api/projects`	signed in
GET	`/api/projects/:id`	signed in
POST	`/api/projects/:id/costs`	signed in

properties 2

Method	Path	Access
GET	`/api/properties`	signed in
GET	`/api/properties/:id`	signed in

renew 1

Method	Path	Access
GET	`/api/renew/:id/:answer/:sig`	signed in

renewals 1

Method	Path	Access
GET	`/api/renewals`	signed in

rentroll 1

Method	Path	Access
GET	`/api/rentroll`	signed in

reports 6

Method	Path	Access
GET	`/api/reports/arrears`	signed in
GET	`/api/reports/export/:what`	signed in
GET	`/api/reports/occupancy`	signed in
GET	`/api/reports/pnl`	signed in
GET	`/api/reports/projects`	signed in
GET	`/api/reports/rent-roll`	signed in

search 2

Method	Path	Access
GET	`/api/search`	signed in
GET	`/api/search/coverage`	signed in

sender-domains 1

Method	Path	Access
GET	`/api/sender-domains/:domain/dkim`	signed in

sender-emails 6

Method	Path	Access
POST	`/api/sender-emails`	signed in
DELETE	`/api/sender-emails/:id`	signed in
PUT	`/api/sender-emails/:id`	signed in
POST	`/api/sender-emails/:id/primary`	signed in
POST	`/api/sender-emails/:id/resend`	signed in
POST	`/api/sender-emails/:id/verify`	signed in

sender-options 1

Method	Path	Access
GET	`/api/sender-options`	signed in

sender-prefs 1

Method	Path	Access
GET	`/api/sender-prefs`	signed in

session 1

Method	Path	Access
GET	`/api/session`	signed in

settings 2

Method	Path	Access
GET	`/api/settings`	administrator
PUT	`/api/settings`	administrator

statements 1

Method	Path	Access
GET	`/api/statements/:property_id`	signed in

tenant-docs 2

Method	Path	Access
DELETE	`/api/tenant-docs/:id`	administrator
GET	`/api/tenant-docs/:id/download`	signed in

tenants 2

Method	Path	Access
GET	`/api/tenants/:id/detail`	signed in
POST	`/api/tenants/:id/docs`	signed in

units 1

Method	Path	Access
GET	`/api/units`	signed in

username 1

Method	Path	Access
POST	`/api/username/forgot`	public

users 3

Method	Path	Access
GET	`/api/users`	administrator
POST	`/api/users`	administrator
PUT	`/api/users/:id`	administrator

vendor-bills 3

Method	Path	Access
GET	`/api/vendor-bills`	signed in
POST	`/api/vendor-bills`	signed in
POST	`/api/vendor-bills/:id/pay`	signed in