Documentation › Nexus Investec › REST API

REST API for Nexus Investec

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

285 endpoints in 74 resource groups.

accounts · activity · alerts · analytics · approval-policies · approvals · attribution · automation · benchmarks · capital-calls · carry · commitments · compliance · connect · covenant-metrics · crm · custom-domain · dd-items · deal-cp · deal-plan · deal-tasks · deal-team · deals · debt · distributions · documents · dq · entities · esg · exec · expenses · explore · facilities · fee-offsets · fees · findash · fundraising · funds · fx · gl-periods · health · investors · journals · jurisdictions · lang · liquidity · loan-notices · login · logout · mandates · me · nav · nxtz · pam · perms · portal · portcfg · portfolio · prospects · providers · push · reports · risk · scenarios · search · sign · sso · subscriptions · tax-docs · uam · username · validis · valuations · whatif

accounts 1

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

activity 1

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

alerts 2

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

analytics 1

Method	Path	Access
GET	`/api/analytics/firm`	signed in

approval-policies 3

Method	Path	Access
GET	`/api/approval-policies`	signed in
POST	`/api/approval-policies`	signed in
PUT	`/api/approval-policies/:id`	signed in

approvals 3

Method	Path	Access
GET	`/api/approvals`	signed in
POST	`/api/approvals/:id/approve`	signed in
POST	`/api/approvals/:id/reject`	signed in

attribution 1

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

automation 3

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

benchmarks 2

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

capital-calls 5

Method	Path	Access
GET	`/api/capital-calls`	signed in
POST	`/api/capital-calls`	signed in
GET	`/api/capital-calls/:id`	signed in
POST	`/api/capital-calls/:id/issue`	signed in
POST	`/api/capital-calls/:id/receive`	signed in

carry 4

Method	Path	Access
GET	`/api/carry/plans`	signed in
POST	`/api/carry/plans`	signed in
POST	`/api/carry/plans/:id/awards`	signed in
GET	`/api/carry/statement`	signed in

commitments 1

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

compliance 4

Method	Path	Access
GET	`/api/compliance/dashboard`	signed in
POST	`/api/compliance/generate`	signed in
GET	`/api/compliance/obligations`	signed in
POST	`/api/compliance/obligations/:id`	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

covenant-metrics 1

Method	Path	Access
GET	`/api/covenant-metrics`	signed in

crm 13

Method	Path	Access
GET	`/api/crm`	signed in
GET	`/api/crm/:id`	signed in
POST	`/api/crm/:id/consent`	signed in
POST	`/api/crm/:id/contacts`	signed in
POST	`/api/crm/:id/interactions`	signed in
POST	`/api/crm/:id/requests`	signed in
GET	`/api/crm/audience`	signed in
DELETE	`/api/crm/contacts/:cid`	signed in
GET	`/api/crm/pipeline`	signed in
POST	`/api/crm/requests/:rid/close`	signed in
POST	`/api/crm/tasks`	signed in
POST	`/api/crm/tasks/:tid/done`	signed in
GET	`/api/crm/tasks/all`	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

dd-items 1

Method	Path	Access
PUT	`/api/dd-items/:id`	signed in

deal-cp 1

Method	Path	Access
PUT	`/api/deal-cp/:id`	signed in

deal-plan 1

Method	Path	Access
PUT	`/api/deal-plan/:id`	signed in

deal-tasks 1

Method	Path	Access
PUT	`/api/deal-tasks/:id`	signed in

deal-team 1

Method	Path	Access
DELETE	`/api/deal-team/:id`	signed in

deals 13

Method	Path	Access
GET	`/api/deals`	signed in
POST	`/api/deals`	signed in
GET	`/api/deals/:id`	signed in
PUT	`/api/deals/:id`	signed in
POST	`/api/deals/:id/close`	signed in
POST	`/api/deals/:id/cp`	signed in
POST	`/api/deals/:id/dd`	signed in
POST	`/api/deals/:id/memo`	signed in
POST	`/api/deals/:id/plan`	signed in
POST	`/api/deals/:id/stage`	signed in
POST	`/api/deals/:id/tasks`	signed in
POST	`/api/deals/:id/team`	signed in
POST	`/api/deals/:id/vote`	signed in

debt 1

Method	Path	Access
GET	`/api/debt/sensitivity`	signed in

distributions 5

Method	Path	Access
GET	`/api/distributions`	signed in
POST	`/api/distributions`	signed in
GET	`/api/distributions/:id`	signed in
POST	`/api/distributions/:id/pay`	signed in
POST	`/api/distributions/preview`	signed in

documents 3

Method	Path	Access
GET	`/api/documents`	signed in
POST	`/api/documents`	signed in
GET	`/api/documents/:id/content`	signed in

dq 1

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

entities 8

Method	Path	Access
GET	`/api/entities`	signed in
POST	`/api/entities`	signed in
GET	`/api/entities/:id`	signed in
GET	`/api/entities/:id/books`	signed in
POST	`/api/entities/:id/books`	signed in
POST	`/api/entities/:id/journals`	signed in
POST	`/api/entities/:id/journals/fee-income`	signed in
POST	`/api/entities/:id/officers`	signed in

esg 4

Method	Path	Access
GET	`/api/esg`	signed in
POST	`/api/esg`	signed in
POST	`/api/esg/climate`	signed in
GET	`/api/esg/rollup`	signed in

exec 3

Method	Path	Access
GET	`/api/exec/narrative`	signed in
GET	`/api/exec/overview`	signed in
GET	`/api/exec/trends`	signed in

expenses 4

Method	Path	Access
GET	`/api/expenses`	signed in
POST	`/api/expenses`	signed in
DELETE	`/api/expenses/:id`	signed in
POST	`/api/expenses/:id/allocate`	signed in

explore 3

Method	Path	Access
GET	`/api/explore`	signed in
GET	`/api/explore/meta`	signed in
GET	`/api/explore/value-bridge/:companyId`	signed in

facilities 9

Method	Path	Access
GET	`/api/facilities`	signed in
POST	`/api/facilities`	signed in
GET	`/api/facilities/:id`	signed in
GET	`/api/facilities/:id/accrual-preview`	signed in
GET	`/api/facilities/:id/loan-notices`	signed in
POST	`/api/facilities/:id/loan-notices`	signed in
GET	`/api/facilities/:id/schedule`	signed in
POST	`/api/facilities/:id/terms`	signed in
POST	`/api/facilities/:id/test`	signed in

fee-offsets 1

Method	Path	Access
DELETE	`/api/fee-offsets/:oid`	signed in

fees 1

Method	Path	Access
POST	`/api/fees/calculate`	signed in

findash 1

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

fundraising 1

Method	Path	Access
GET	`/api/fundraising/:fundId/pipeline`	signed in

funds 18

Method	Path	Access
GET	`/api/funds`	signed in
POST	`/api/funds`	signed in
GET	`/api/funds/:fund/investors/:investor/performance`	signed in
PUT	`/api/funds/:id`	signed in
GET	`/api/funds/:id/capital-accounts`	signed in
GET	`/api/funds/:id/clawback-preview`	signed in
GET	`/api/funds/:id/equalisation-preview`	signed in
GET	`/api/funds/:id/fee-offsets`	signed in
POST	`/api/funds/:id/fee-offsets`	signed in
GET	`/api/funds/:id/fee-schedule`	signed in
PUT	`/api/funds/:id/fee-terms`	signed in
GET	`/api/funds/:id/overview`	signed in
GET	`/api/funds/:id/performance`	signed in
GET	`/api/funds/:id/pme`	signed in
GET	`/api/funds/:id/regulatory/:report`	signed in
GET	`/api/funds/:id/tax-pack`	signed in
GET	`/api/funds/:id/trial-balance`	signed in
PUT	`/api/funds/:id/waterfall-tiers`	signed in

fx 5

Method	Path	Access
GET	`/api/fx`	signed in
GET	`/api/fx/exposure`	signed in
GET	`/api/fx/history`	signed in
POST	`/api/fx/rates`	signed in
POST	`/api/fx/reval`	signed in

gl-periods 3

Method	Path	Access
GET	`/api/gl-periods`	signed in
POST	`/api/gl-periods/close`	signed in
POST	`/api/gl-periods/reopen`	signed in

health 1

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

investors 4

Method	Path	Access
GET	`/api/investors`	signed in
POST	`/api/investors`	signed in
GET	`/api/investors/:id`	signed in
GET	`/api/investors/:id/statement`	signed in

journals 2

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

jurisdictions 1

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

lang 2

Method	Path	Access
GET	`/api/lang/enabled`	signed in
PUT	`/api/lang/enabled`	administrator

liquidity 1

Method	Path	Access
GET	`/api/liquidity/forecast`	signed in

loan-notices 2

Method	Path	Access
DELETE	`/api/loan-notices/:id`	signed in
POST	`/api/loan-notices/:id/post`	signed in

Method	Path	Access
POST	`/api/login`	public

logout 1

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

mandates 4

Method	Path	Access
GET	`/api/mandates`	signed in
POST	`/api/mandates`	signed in
DELETE	`/api/mandates/:id`	signed in
POST	`/api/mandates/run`	signed in

me 4

Method	Path	Access
GET	`/api/me`	signed in
POST	`/api/me/password`	signed in
GET	`/api/me/profile`	signed in
PUT	`/api/me/profile`	signed in

nav 3

Method	Path	Access
GET	`/api/nav`	signed in
POST	`/api/nav`	signed in
POST	`/api/nav/:id/approve`	signed in

nxtz 3

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

pam 20

Method	Path	Access
GET	`/api/pam/composites`	signed in
POST	`/api/pam/composites`	signed in
GET	`/api/pam/composites/:id/report`	signed in
GET	`/api/pam/factor/:fundId`	signed in
GET	`/api/pam/instruments`	signed in
POST	`/api/pam/instruments`	signed in
GET	`/api/pam/lookthrough`	signed in
GET	`/api/pam/marketdata`	signed in
POST	`/api/pam/marketdata`	signed in
GET	`/api/pam/pacing/:fundId`	signed in
GET	`/api/pam/positions`	signed in
GET	`/api/pam/pretrade`	signed in
POST	`/api/pam/pretrade`	signed in
GET	`/api/pam/recon`	signed in
POST	`/api/pam/recon`	signed in
GET	`/api/pam/recon/:id`	signed in
POST	`/api/pam/recon/:id/resolve`	signed in
POST	`/api/pam/roll`	signed in
GET	`/api/pam/summary`	signed in
GET	`/api/pam/twr/:fundId`	signed in

perms 2

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

portal 7

Method	Path	Access
GET	`/api/portal/activity`	signed in
GET	`/api/portal/documents`	signed in
GET	`/api/portal/documents/:id`	signed in
POST	`/api/portal/login`	signed in
POST	`/api/portal/logout`	signed in
GET	`/api/portal/me`	signed in
GET	`/api/portal/positions`	signed in

portcfg 1

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

portfolio 3

Method	Path	Access
GET	`/api/portfolio`	signed in
GET	`/api/portfolio/:id`	signed in
POST	`/api/portfolio/:id/kpi`	signed in

prospects 2

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

providers 6

Method	Path	Access
POST	`/api/providers/benchmarks/ingest`	administrator
GET	`/api/providers/benchmarks/summary`	administrator
GET	`/api/providers/notices`	administrator
POST	`/api/providers/notices/:id/close`	administrator
POST	`/api/providers/notices/:id/fund`	administrator
POST	`/api/providers/notices/ingest`	administrator

push 4

Method	Path	Access
GET	`/api/push/key`	signed in
POST	`/api/push/subscribe`	signed in
POST	`/api/push/test`	signed in
POST	`/api/push/unsubscribe`	signed in

reports 3

Method	Path	Access
GET	`/api/reports/runs`	signed in
POST	`/api/reports/runs`	signed in
GET	`/api/reports/runs/:id`	signed in

risk 3

Method	Path	Access
GET	`/api/risk/exposure`	signed in
POST	`/api/risk/stress`	signed in
GET	`/api/risk/var`	signed in

scenarios 2

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

search 2

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

sign 10

Method	Path	Access
GET	`/api/sign/requests`	signed in
POST	`/api/sign/requests`	signed in
POST	`/api/sign/requests/:id/cancel`	signed in
POST	`/api/sign/requests/:id/resend`	signed in
GET	`/api/sign/requests/:id/sealed`	signed in
GET	`/api/sign/t/:token`	public
POST	`/api/sign/t/:token/complete`	public
POST	`/api/sign/t/:token/decline`	public
GET	`/api/sign/t/:token/doc`	public
GET	`/api/sign/verify/:vid`	public

sso 1

Method	Path	Access
POST	`/api/sso/accounts`	signed in

subscriptions 6

Method	Path	Access
GET	`/api/subscriptions`	signed in
POST	`/api/subscriptions`	signed in
POST	`/api/subscriptions/:id/admit`	signed in
POST	`/api/subscriptions/:id/cancel`	signed in
POST	`/api/subscriptions/:id/document`	signed in
POST	`/api/subscriptions/:id/send`	signed in

tax-docs 5

Method	Path	Access
GET	`/api/tax-docs`	signed in
POST	`/api/tax-docs`	signed in
DELETE	`/api/tax-docs/:id`	signed in
POST	`/api/tax-docs/:id/publish`	signed in
POST	`/api/tax-docs/:id/unpublish`	signed in

uam 5

Method	Path	Access
GET	`/api/uam/roles`	signed in
GET	`/api/uam/users`	administrator
POST	`/api/uam/users/:id/assign`	administrator
GET	`/api/uam/users/:id/scope`	administrator
PUT	`/api/uam/users/:id/scope`	administrator

username 1

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

validis 9

Method	Path	Access
GET	`/api/validis/config`	administrator
PUT	`/api/validis/config`	administrator
POST	`/api/validis/ingest`	administrator
GET	`/api/validis/links`	administrator
POST	`/api/validis/links`	administrator
DELETE	`/api/validis/links/:id`	administrator
DELETE	`/api/validis/pending/:id`	administrator
GET	`/api/validis/runs`	administrator
POST	`/api/validis/sync`	administrator

valuations 1

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

whatif 1

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