novumstate-middleware

List Complexes

List property complexes (groups of properties). Filter by name/city/street with q.

Get Complex

Get one property complex, optionally with its properties and their units nested.

List Properties

List properties (buildings/objects), optionally within one complex or matching q.

Get Property

Get one property with its units, technical details, and associated contacts (owner, accountant, and everyone linked to its units with their roles).

List Units

List units (apartments/commercial spaces), optionally within one property.

Get Unit

Get one unit with its contacts (tenants/owners with roles and validity ranges) and the contracts targeting it.

Search Contacts

Search contacts by name (q), email address, or phone number. Each result embeds the contact's emails, phone numbers, and bank accounts.

Get Contact

Get one contact with emails/phones/bank accounts, the units they are linked to (with role: tenant, owner, ...), their legal-entity memberships, and the contracts they are party to.

List Contracts

List contracts filtered by targeted property/unit, involved contact, or active flag.

Get Contract

Get one contract with its targets (property/unit/asset), giver and receiver legal entities including their member contacts (this shows how a group of contacts is related), content, services, and fees.

Get Schema

Return the full current list of tables and columns available in the middleware, with business descriptions, foreign keys, and CHECK/UNIQUE constraints. This is the authoritative, always-current data model — do not assume a table/column exists (or that a text column accepts arbitrary values) because it is mentioned in older documentation or a previous conversation; check here. Several columns are a fixed allowlist of strings enforced by a CHECK constraint rather than a rea

Describe Table

Return columns (with types and business descriptions), foreign keys, and CHECK/UNIQUE constraints for one table. Use this before writing any query or code against a specific table — in particular, check check_constraints before writing to any column that looks like a status or type flag, since the database will reject values outside its allowlist even if your code doesn't validate them first. A merged_into_id column means the table retains the losing row of every mer

Propose Datamodel Change

Submit a request for a datamodel change (a new table/column, or a modification to an existing one) for the Novumstate team to review. Use this instead of creating tables/columns yourself or working around a gap by repurposing an unrelated field — you have no ability to alter the schema, and doing so silently would make the middleware hard to reason about for everyone else building on it. Clearly state the status quo (what exists today), what you need, and why.

List Invoices

List Impower invoices with server-side filters (read-only). Entry point for building invoice reports. Results are trimmed to the common report fields unless `full=True`. Args: state: invoice state, e.g. NEW, READY_FOR_APPROVAL, APPROVED, RECURRING, RECURRING_STOPPED, DELETED, OVERDUE, SENT_TO_BANK, PAID. direction: INCOMING or OUTGOING (payment direction), if used. property_hr_id: filter by property human-readable id. invoice_number: filt

Get Invoice

Fetch one Impower invoice by its human-readable id (invoiceHrId), full detail. Includes bookings, payments and standing-order info when present.

Get Invoice Payments

List the payments recorded for an Impower invoice (by invoiceHrId).

Get Invoice Validation

Return Impower's validation result for an invoice (by invoiceHrId). Useful to flag invoices that are missing required data or would be rejected on approval.

Bank Account Balances

Current balance of each Impower bank account, by IBAN. Primary source is property-bank-accounts, whose `balance` is the current *booked* accounting balance per property bank account. Each row is enriched with the latest bank *statement* balance + date from banking-bank-accounts (often stale or null, but useful to reconcile against). Args: ibans: optional comma-separated IBAN list to restrict the result. property_hr_id: optional single property to restrict th

List Bank Transactions

List Impower bank transactions with server-side filters (read-only). Args: from_date / until_date: ISO date range (YYYY-MM-DD) on the bank date. statuses: comma-separated transactionPaymentStatus values — UNASSIGNED, ASSIGNED, PARTIALLY_BOOKED, WONT_BE_ALLOCATED, DUPLICATE, DELETED. direction: INCOMING or OUTGOING. property_iban / property_name: filter by the property's bank account. counterpart_name: filter by counterpart name

Bank Transactions Summary

Fast counts for an Impower bank-transaction filter, without downloading rows. Returns {totalTransactions, totalBankAccounts}.

Unbooked Backlog

Backlog of unbooked Impower items ('số lượng tồn chưa được book'). Combines: - bank: count of UNASSIGNED bank transactions - invoices: count per state that is not yet booked/approved Args: property_iban: restrict the bank count to one property IBAN. invoice_states: comma-separated invoice states to treat as backlog. Returns {bank_unassigned, bank_accounts_with_unassigned, invoices:{state:count}, invoices_total, invoices_truncated}.

Daily Counts

Per-day counts of new or booked Impower items. Examples: - New invoices per day: dataset="invoices", mode="new" - Booked invoices/day: dataset="invoices", mode="booked" (state=APPROVED) - New bank tx per day: dataset="bank", mode="new" - Booked bank tx/day: dataset="bank", mode="booked" (status=ASSIGNED) Args: dataset: "invoices" or "bank". from_date / to_date: inclusive ISO date range (YYYY-MM-DD). mode: "new" or "booked"

Db List Tables

List the middleware database tables available to db_query, with their business description and an estimated row count. Two families: - `ns_*` — the canonical model: the middleware's normalized truth, shared across every source system. Five of them (ns_contacts, ns_contract, ns_legal_entity, ns_property_object, ns_unit) retain merge losers and soft-deleted rows — see db_query before counting anything in them. - `sf_*` — the Salesforce staging mirror, as received

Db Describe Table

Return the columns (types, nullability, defaults, business descriptions), foreign keys, CHECK constraints and indexes of one table. Call this before querying a table you have not inspected in this conversation: column names differ between the `sf_*` staging tables (which mirror Salesforce API field names) and the `ns_*` canonical tables, and the CHECK constraints tell you the exact values a status-like column can hold. If the output has a `merged_into_id` column, the ta

Db Query

Run one read-only SQL SELECT against the middleware database. Only a single SELECT (or WITH ... SELECT) is accepted. Writes, DDL, multiple statements and transaction control are rejected server-side, and the connection is read-only at the database level — nothing here can change data. To request a schema change, use propose_datamodel_change. Args: sql: the SELECT statement, Postgres dialect. No trailing semicolon, no second statement. limit: maxi