API Reference

Integrate with the Numbors platform using our REST API. Manage contacts, invoices, inventory, CRM, and more.

OpenAPI 3.0 Download YAML

Base URL

All API requests are relative to:

https://app.numbors.com/api

Authentication

Include a JWT token with every request:

Authorization: Bearer <token>

Company Context

Send your company ID as a header:

X-Company-Id: <id>

Response Format

All responses return JSON with:

{ "success": true, "data": [...] }

Authentication

Register, login, and retrieve the current user.

POST /api/auth/register Public Register a new user
Responses
201 Created
400 Validation error
POST /api/auth/login Public Log in and receive a JWT
Responses
201 Created
400 Validation error
GET /api/auth/me Get current authenticated user
Responses
200 OK

Modules

Query enabled modules and license information.

GET /api/modules/enabled List enabled modules
Responses
200 OK
GET /api/modules/check/{alias} Check if specific module is accessible
Parameters
NameInTypeDescription
alias * path string
Responses
200 OK
404 Not found
GET /api/modules/licenses Get detailed license information
Responses
200 OK

Companies

List companies accessible to the authenticated user.

GET /api/companies List accessible companies
Responses
200 OK

Contacts

Manage customers, suppliers, and other contacts.

GET /api/contacts List contacts
Responses
200 OK
POST /api/contacts Create a contacts
Responses
201 Created
400 Validation error
GET /api/contacts/{id} Get a contacts
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 OK
404 Not found
PUT /api/contacts/{id} Update a contacts
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated
DELETE /api/contacts/{id} Delete a contacts
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Deleted

Documents

Create and manage invoices, bills, and other financial documents.

GET /api/documents List documents
Responses
200 OK
POST /api/documents Create a documents
Responses
201 Created
400 Validation error
GET /api/documents/{id} Get a documents
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 OK
404 Not found
PUT /api/documents/{id} Update a documents
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated
DELETE /api/documents/{id} Delete a documents
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Deleted

Accounts

Bank accounts and cash accounts.

GET /api/accounts List accounts
Responses
200 OK
POST /api/accounts Create an accounts
Responses
201 Created
400 Validation error

Transactions

Income and expense transactions.

GET /api/transactions List transactions
Responses
200 OK
POST /api/transactions Create a transactions
Responses
201 Created
400 Validation error

Items

Products and services used on invoices and bills.

GET /api/items List items
Responses
200 OK
POST /api/items Create an items
Responses
201 Created
400 Validation error

Categories

Income and expense categories.

GET /api/categories List categories
Responses
200 OK
POST /api/categories Create a categories
Responses
201 Created
400 Validation error
PUT /api/categories/{id} Update a categories
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated

Taxes

Tax rates applied to line items.

GET /api/taxes List taxes
Responses
200 OK
POST /api/taxes Create a taxes
Responses
201 Created
400 Validation error
PUT /api/taxes/{id} Update a taxes
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated

Currencies

Multi-currency support.

GET /api/currencies List currencies
Responses
200 OK
POST /api/currencies Create a currencies
Responses
201 Created
400 Validation error

Estimates

Quotes and estimates sent to customers.

GET /api/estimates List estimates
Responses
200 OK
POST /api/estimates Create an estimates
Responses
201 Created
400 Validation error
GET /api/estimates/{id} Get an estimates
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 OK
404 Not found
PUT /api/estimates/{id} Update an estimates
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated
DELETE /api/estimates/{id} Delete an estimates
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Deleted

Credit Notes

Credit notes issued against invoices.

GET /api/credit-notes List credit notes
Responses
200 OK
POST /api/credit-notes Create a credit notes
Responses
201 Created
400 Validation error

Accounting

Chart of accounts and journal entries.

GET /api/accounting/chart-of-accounts List accounting chart of accounts
Responses
200 OK
POST /api/accounting/chart-of-accounts Create an accounting chart of accounts
Responses
201 Created
400 Validation error
GET /api/accounting/journal List accounting journal
Responses
200 OK
POST /api/accounting/journal Create an accounting journal
Responses
201 Created
400 Validation error

Inventory

Warehouses, stock transfers, and adjustments.

GET /api/inventory/warehouses List inventory warehouses
Responses
200 OK
POST /api/inventory/warehouses Create an inventory warehouses
Responses
201 Created
400 Validation error
GET /api/inventory/transfers List inventory transfers
Responses
200 OK
POST /api/inventory/transfers Create an inventory transfers
Responses
201 Created
400 Validation error
POST /api/inventory/adjustments Create an inventory adjustments
Responses
201 Created
400 Validation error

Projects

Project management and time tracking.

GET /api/projects List projects
Responses
200 OK
POST /api/projects Create a projects
Responses
201 Created
400 Validation error
GET /api/projects/{id} Get a projects
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 OK
404 Not found
PUT /api/projects/{id} Update a projects
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 Updated
POST /api/projects/{id}/tasks Create a projects tasks
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
201 Created
400 Validation error
GET /api/projects/time List projects time
Responses
200 OK
POST /api/projects/time Create a projects time
Responses
201 Created
400 Validation error

Payroll

Departments, employees, and pay runs.

GET /api/payroll/departments List payroll departments
Responses
200 OK
POST /api/payroll/departments Create a payroll departments
Responses
201 Created
400 Validation error
GET /api/payroll/employees List payroll employees
Responses
200 OK
POST /api/payroll/employees Create a payroll employees
Responses
201 Created
400 Validation error
GET /api/payroll/pay-runs List payroll pay runs
Responses
200 OK
POST /api/payroll/pay-runs Create a payroll pay runs
Responses
201 Created
400 Validation error

Point of Sale

POS terminals, sessions, orders, and loyalty programmes.

GET /api/pos/terminals List pos terminals
Responses
200 OK
POST /api/pos/terminals Create a pos terminals
Responses
201 Created
400 Validation error
GET /api/pos/sessions List pos sessions
Responses
200 OK
POST /api/pos/sessions/open Open a new POS session
Responses
201 Created
400 Validation error
POST /api/pos/orders Create a pos orders
Responses
201 Created
400 Validation error
GET /api/pos/loyalty List pos loyalty
Responses
200 OK
POST /api/pos/loyalty/programs Create a pos loyalty programs
Responses
201 Created
400 Validation error

CRM

Pipelines, leads, deals, activities, and campaigns.

GET /api/crm/pipelines List crm pipelines
Responses
200 OK
POST /api/crm/pipelines Create a crm pipelines
Responses
201 Created
400 Validation error
GET /api/crm/leads List crm leads
Responses
200 OK
POST /api/crm/leads Create a crm leads
Responses
201 Created
400 Validation error
GET /api/crm/deals List crm deals
Responses
200 OK
POST /api/crm/deals Create a crm deals
Responses
201 Created
400 Validation error
GET /api/crm/activities List crm activities
Responses
200 OK
POST /api/crm/activities Create a crm activities
Responses
201 Created
400 Validation error
GET /api/crm/campaigns List crm campaigns
Responses
200 OK
POST /api/crm/campaigns Create a crm campaigns
Responses
201 Created
400 Validation error

Contracts & Proposals

Manage contracts and send proposals.

GET /api/contracts List contracts
Responses
200 OK
POST /api/contracts Create a contracts
Responses
201 Created
400 Validation error
GET /api/contracts/proposals List contracts proposals
Responses
200 OK
POST /api/contracts/proposals Create a contracts proposals
Responses
201 Created
400 Validation error

Helpdesk

Ticket categories, tickets, SLAs, and knowledge-base articles.

GET /api/helpdesk/categories List helpdesk categories
Responses
200 OK
POST /api/helpdesk/categories Create a helpdesk categories
Responses
201 Created
400 Validation error
GET /api/helpdesk/tickets List helpdesk tickets
Responses
200 OK
POST /api/helpdesk/tickets Create a helpdesk tickets
Responses
201 Created
400 Validation error
GET /api/helpdesk/slas List helpdesk slas
Responses
200 OK
POST /api/helpdesk/slas Create a helpdesk slas
Responses
201 Created
400 Validation error
GET /api/helpdesk/articles List helpdesk articles
Responses
200 OK
POST /api/helpdesk/articles Create a helpdesk articles
Responses
201 Created
400 Validation error

Orders

Sales orders and purchase orders.

GET /api/sales/orders List sales orders
Responses
200 OK
POST /api/sales/orders Create a sales orders
Responses
201 Created
400 Validation error
GET /api/purchases/orders List purchases orders
Responses
200 OK
POST /api/purchases/orders Create a purchases orders
Responses
201 Created
400 Validation error

Banking

Open-banking feeds, connections, and auto-categorisation rules.

GET /api/banking/feeds List banking feeds
Responses
200 OK
GET /api/banking/feeds/connections List banking feeds connections
Responses
200 OK
POST /api/banking/feeds/connections Create a banking feeds connections
Responses
201 Created
400 Validation error
GET /api/banking/feeds/rules List banking feeds rules
Responses
200 OK
POST /api/banking/feeds/rules Create a banking feeds rules
Responses
201 Created
400 Validation error

Transfers

Inter-account transfers.

GET /api/transfers List transfers
Responses
200 OK
POST /api/transfers Create a transfers
Responses
201 Created
400 Validation error

Support Chat

Public AI-powered support chat. No authentication required for chat and history.

POST /api/support/chat Public Send message and get AI response
Responses
201 Created
400 Validation error
GET /api/support/history/{sessionId} Public ─── GET /api/support/history/:sessionId — PUBLIC ───────────────────────────
Parameters
NameInTypeDescription
sessionId * path string
Responses
200 OK
404 Not found
POST /api/support/escalate Escalate to helpdesk ticket (auth required)
Responses
201 Created
400 Validation error

Tai Dev Lifecycle

Internal dev lifecycle management: bugs, roadmap, features, and AI experts.

POST /api/tai/message Ask Tai a question
Responses
201 Created
400 Validation error
GET /api/tai/status Get system state summary
Responses
200 OK
GET /api/tai/bugs List tracked bugs
Responses
200 OK
POST /api/tai/bug Report a bug
Responses
201 Created
400 Validation error
GET /api/tai/roadmap Get current roadmap
Responses
200 OK
POST /api/tai/e2e-fix Auto-create bug from E2E failure
Responses
201 Created
400 Validation error
GET /api/tai/log Get recent session log
Responses
200 OK
GET /api/tai/experts List registered experts
Responses
200 OK

Tai Features

Feature tracking via Buggazi integration.

POST /api/tai/feature Add a feature
Responses
201 Created
400 Validation error
GET /api/tai/features List features
Responses
200 OK
GET /api/tai/features/board Get feature board
Responses
200 OK
GET /api/tai/features/stats Get feature stats
Responses
200 OK
PATCH /api/tai/feature/{featureId} Update a tai feature
Parameters
NameInTypeDescription
featureId * path string
Responses
200 Updated
POST /api/tai/feature/{featureId}/link-bug Create a tai feature link bug
Parameters
NameInTypeDescription
featureId * path string
Responses
201 Created
400 Validation error

Tai Sprints

Sprint management via Buggazi integration.

GET /api/tai/sprint/active Get active sprint
Responses
200 OK
POST /api/tai/sprint Create a sprint
Responses
201 Created
400 Validation error
PATCH /api/tai/sprint/{sprintId} Update a tai sprint
Parameters
NameInTypeDescription
sprintId * path string
Responses
200 Updated

Tai Bugfixer

Automated bug-fixing conductor and stats.

POST /api/tai/bugfix/{domain} Create a tai bugfix
Parameters
NameInTypeDescription
domain * path string
Responses
201 Created
400 Validation error
GET /api/tai/bugfix/stats Get bug-fix stats
Responses
200 OK

Tai Seed Conductor

Seed data profile management and recommendation.

GET /api/tai/seed/profiles List seed profiles
Responses
200 OK
GET /api/tai/seed/profile/{id} ─── GET /api/tai/seed/profile/:id ──────────────────────────────────────────
Parameters
NameInTypeDescription
id * path string MongoDB ObjectId
Responses
200 OK
404 Not found
POST /api/tai/seed/recommend Recommend a seed profile
Responses
201 Created
400 Validation error
GET /api/tai/seed/state Get seed state
Responses
200 OK
GET /api/tai/seed/graph Get seeder dependency graph
Responses
200 OK

AI Insights

AI-powered financial report analysis and insights.

GET /api/ai-insights/status Public Check AI availability
Responses
200 OK
GET /api/ai-insights/workflows Public List available conductor workflows
Responses
200 OK
POST /api/ai-insights/analyse Generate AI insights for a report
Responses
201 Created
400 Validation error
POST /api/ai-insights/analyse-stream Stream AI analysis via SSE
Responses
201 Created
400 Validation error
GET /api/ai-insights/audit Get AI insight audit trail
Responses
200 OK
POST /api/ai-insights/memory-hook Public AgenticMemory webhook for real-time notifications
Responses
201 Created
400 Validation error
POST /api/ai-insights/shared Write shared world memory fact
Responses
201 Created
400 Validation error
GET /api/ai-insights/shared Read shared world memory facts
Responses
200 OK

Compliance

Compliance posture snapshots and OCSF audit export.

GET /api/compliance/snapshot Get full compliance posture snapshot
Responses
200 OK
GET /api/compliance/export Export OCSF audit data
Responses
200 OK