Skip to main content

MCP tool reference

Every tool the etg24 MCP server exposes, grouped by layer and domain. Meta-tools are advertised viatools/list; domain tools are discovered at runtime throughmeta.tools.search and invoked via meta.tool.execute. See the meta-tool workflow for how they fit together.

Catalogue generated at 2026-08-20T10:29:28+00:00.

Meta-tools8 tools

meta8 tools

meta.tool.describemetaMeta-tools

Return the full input schema, output schema, and description for one or more tools by name. Use after meta.tools.search to inspect a tool's complete contract before executing it.

Arguments

NameTypeRequiredDescription
toolNamesarray<string>yesNames of the tools to describe.
meta.tool.executemetaMeta-tools

Execute a single API endpoint tool by name with the given arguments. Optionally post-process the response with a JMESPath expression via _transform. This dispatcher is never annotated as destructive itself; before executing a write operation, call meta.tool.describe on the target tool and check its annotations.

Arguments

NameTypeRequiredDescription
namestringyesName of the tool to execute.
argumentsobjectnoArguments passed to the tool.
_transformstringnoOptional JMESPath expression applied to the response.
meta.pipeline.executemetaMeta-tools

Execute a sequence of tool calls where later steps can reference results from earlier steps via JMESPath expressions. Enables cross-tool composition without custom code. This dispatcher is never annotated as destructive itself; inspect each step's tool with meta.tool.describe before running a pipeline that writes data.

Arguments

NameTypeRequiredDescription
stepsarray<object>yesOrdered pipeline steps. Each step has a "tool" name, optional "arguments", an optional "as" variable name, and an optional "transform" JMESPath expression.
meta.thesaurus.glossarymetaMeta-tools

Return the full glossary of thesaurus entries for one or more domains, projected into the requested language.

Arguments

NameTypeRequiredDescription
domainsarray<string>yesDomain IDs to include.
projectionstringnoLanguage projection for the results.
meta.thesaurus.domainsmetaMeta-tools

List available thesaurus domains with descriptions and glossary size, so agents can estimate context-window cost before requesting a full glossary.

Platform API1 tools

versionqueryPlatform API

Returns version.

Endpoint

GET /api/platform/v1/query/version

Property Management v276 tools

accounting17 tools

accounting.bankaccountinfos.create.contactcommandProperty Management v2

Creates bank account info for contact.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.bankaccountinfos.create.contact

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountInfoobjectyesThe bank account info to create for the contact.
contactstringyesThe contact to associate the bank account info with, referenced by ID or alias.
accounting.bankaccountinfos.create.objectcommandProperty Management v2

Creates bank account info for object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.bankaccountinfos.create.object

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountInfoobjectyesThe bank account info to create for the object.
objectstringyesThe object to associate the bank account info with, referenced by ID or alias.
accounting.bankaccountinfos.updatecommandProperty Management v2

Updates bank account info.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.bankaccountinfos.update

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountInfoobjectyesThe bank account info to update, referenced by ID or alias with updated values.
accounting.bankaccountuse.createcommandProperty Management v2

Creates bank account use.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.bankaccountuse.create

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountUseobjectyesThe bank account use to create.
contractstringyesThe contract to associate the bank account use with, referenced by ID or alias.
accounting.bankaccountuse.updatecommandProperty Management v2

Updates bank account use.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.bankaccountuse.update

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountUseobjectyesThe bank account use to update, referenced by ID or alias with updated values.
accounting.directdebitmandate.createcommandProperty Management v2

Creates direct debit mandate.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.directdebitmandate.create

Scopes

erp

Arguments

NameTypeRequiredDescription
directDebitMandateobjectyesThe direct debit mandate to create.
accounting.directdebitmandate.generatereferencecommandProperty Management v2

Generates direct debit mandate reference.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.directdebitmandate.generatereference

Scopes

erp

Arguments

NameTypeRequiredDescription
directDebitMandatestringyesThe direct debit mandate to generate a reference for, referenced by ID or alias.
accounting.directdebitmandate.updatecommandProperty Management v2

Updates direct debit mandate.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/accounting.directdebitmandate.update

Scopes

erp

Arguments

NameTypeRequiredDescription
directDebitMandateobjectyesThe direct debit mandate to update, referenced by ID or alias with updated values.
accounting.bankaccountinfos.detailqueryProperty Management v2

Shows bank account info.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.bankaccountinfos.detail

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountInfostringyesThe bank account info to show, referenced by ID or alias.
accounting.bankaccountinfos.listqueryProperty Management v2

Lists bank account infos.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.bankaccountinfos.list

Scopes

erp

Arguments

NameTypeRequiredDescription
ibanstringnoFilter results to bank account infos with this IBAN.
objectstringnoFilter results to bank account infos belonging to this object, referenced by ID or alias.
contactstringnoFilter results to bank account infos belonging to this contact, referenced by ID or alias.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
accounting.bankaccountuse.detailqueryProperty Management v2

Shows bank account use.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.bankaccountuse.detail

Scopes

erp

Arguments

NameTypeRequiredDescription
bankAccountUsestringyesThe bank account use to show, referenced by ID or alias.
accounting.contract.bankaccountuse.fordatequeryProperty Management v2

Returns valid bank account use.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.contract.bankaccountuse.fordate

Scopes

erp

Arguments

NameTypeRequiredDescription
contractstringyesThe contract to find a valid bank account use for, referenced by ID or alias.
purposestringyesThe purpose for which the bank account use must be valid.
validOnstringyesThe date on which the bank account use must be valid.
accounting.directdebitmandate.detailqueryProperty Management v2

Shows direct debit mandate.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.directdebitmandate.detail

Scopes

erp

Arguments

NameTypeRequiredDescription
directDebitMandatestringyesThe direct debit mandate to show, referenced by ID or alias.
accounting.directdebitmandates.listqueryProperty Management v2

Lists direct debit mandates.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.directdebitmandates.list

Scopes

erp

Arguments

NameTypeRequiredDescription
ibanstringnoFilter results to direct debit mandates with this IBAN.
objectstringnoFilter results to direct debit mandates belonging to this object, referenced by ID or alias.
contactstringnoFilter results to direct debit mandates belonging to this contact, referenced by ID or alias.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
accounting.inboundinvoices.listqueryProperty Management v2

Lists invoices.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.inboundinvoices.list

Scopes

erp

Arguments

NameTypeRequiredDescription
objectstringyesThe object to list invoices for, referenced by ID or alias.
accounting.inboundinvoices.showqueryProperty Management v2

Shows invoice details and accounting data.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.inboundinvoices.show

Scopes

erp

Arguments

NameTypeRequiredDescription
inboundInvoicestringyesThe inbound invoice to show, referenced by ID or alias.
accounting.object.bankaccountinfosqueryProperty Management v2

Returns object account infos.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/accounting.object.bankaccountinfos

Scopes

erp

Arguments

NameTypeRequiredDescription
objectstringyesThe object to get bank account infos for, referenced by ID or alias.

advisors3 tools

advisors.assigncommandProperty Management v2

Assign an advisor to an object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/advisors.assign

Scopes

erp

Arguments

NameTypeRequiredDescription
advisorobjectyesThe advisor to assign to an object.
advisors.revokecommandProperty Management v2

Revoke an advisor from an object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/advisors.revoke

Scopes

erp

Arguments

NameTypeRequiredDescription
advisorstringyesThe advisor to revoke, referenced by ID or alias.
advisors.listqueryProperty Management v2

List advisors for the current tenant with optional filters and pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/advisors.list

Scopes

erp

Arguments

NameTypeRequiredDescription
objectIdstringnoFilter results to advisors assigned to this object.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.

aliases3 tools

aliases.upsertcommandProperty Management v2

Upserts a batch of aliases for the current (tenant, integration) scope. Each entry takes a bare `alias` (no `$` prefix), an `id` and an entity-`type`.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/aliases.upsert

Scopes

*
aliases.listqueryProperty Management v2

Paginated listing of every alias stored for the current (tenant, integration) scope. Aliases on the wire are returned bare (no `$` prefix). Storage entries that point at an entity type unknown to the current {@see AliasTypeMap} are omitted from the response.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/aliases.list

Scopes

*

Arguments

NameTypeRequiredDescription
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
aliases.resolvequeryProperty Management v2

Bidirectional bulk-resolve of aliases and ids. Inputs are arrays of bare aliases AND/OR internal ids; outputs are tuples `{alias, id, type}` for every successful resolution. Aliases without a mapping and ids that do not have a mapping are simply omitted.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/aliases.resolve

Scopes

*

Arguments

NameTypeRequiredDescription
aliasesarray<string>noThe aliases to resolve to internal ids.
idsarray<string>noThe internal ids to resolve to aliases.

callrecords3 tools

callrecords.createcommandProperty Management v2

Create a new call record.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/callrecords.create

Scopes

erp

Arguments

NameTypeRequiredDescription
callRecordobjectyesThe call record to create.
callrecords.updatecommandProperty Management v2

Update an existing call record.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/callrecords.update

Scopes

erp

Arguments

NameTypeRequiredDescription
callRecordobjectyesThe call record to update, referenced by ID or alias with updated values.
callrecords.showqueryProperty Management v2

Show a call record by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/callrecords.show

Scopes

erp

Arguments

NameTypeRequiredDescription
callRecordstringyesThe call record to show, referenced by ID or alias.

contacts5 tools

contacts.createcommandProperty Management v2

Create a new contact for the current tenant.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/contacts.create

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
contactobjectyesThe contact to create.
contacts.mergecommandProperty Management v2

Merge one or more source contacts into a target contact. Both payloads are Reference-only (id or alias required; no property fields). Returns 200 on success.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/contacts.merge

Scopes

erp

Arguments

NameTypeRequiredDescription
sourceContactstringyesThe source contact to merge into the target, referenced by ID or alias.
targetContactstringyesThe target contact that absorbs the source, referenced by ID or alias.
contacts.updatecommandProperty Management v2

Update an existing contact identified by its payload id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/contacts.update

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
contactobjectyesThe contact to update, referenced by ID or alias with updated values.
contactsqueryProperty Management v2

List contacts for the current tenant with optional filters and pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/contacts

Scopes

erp

Arguments

NameTypeRequiredDescription
companyIdstringnoFilter results to contacts belonging to this company.
personTypestringnoFilter results to contacts with this person type.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
contacts.showqueryProperty Management v2

Show a single contact by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/contacts.show

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
contactstringyesThe contact to show, referenced by ID or alias.

contracts4 tools

contracts.createcommandProperty Management v2

Create a new contract for a unit.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/contracts.create

Scopes

erp

Arguments

NameTypeRequiredDescription
contractobjectyesThe contract data to create.
contracts.updatecommandProperty Management v2

Update an existing contract.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/contracts.update

Scopes

erp

Arguments

NameTypeRequiredDescription
contractobjectyesThe contract to update, referenced by ID or alias.
contractsqueryProperty Management v2

List contracts for the current tenant with optional filters and pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/contracts

Scopes

erp

Arguments

NameTypeRequiredDescription
objectIdstringnoFilter results to contracts belonging to this object.
unitIdstringnoFilter results to contracts belonging to this unit.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
contracts.showqueryProperty Management v2

Show a single contract by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/contracts.show

Scopes

erp

Arguments

NameTypeRequiredDescription
contractstringyesThe contract to show, referenced by ID or alias.

documents5 tools

documents.updatecommandProperty Management v2

Update an existing document.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/documents.update

Scopes

erp

Arguments

NameTypeRequiredDescription
documentobjectyesThe document to update, referenced by ID or alias.
documents.uploadcommandProperty Management v2

Upload a document to a location. Supports objects, contracts, units, object groups, processes, and process updates.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/documents.upload

Scopes

erp

Arguments

NameTypeRequiredDescription
locationIdstringyesThe location to upload the document to.
resourceobjectyesThe uploaded file resource to process.
documentobjectnoThe document metadata for the upload.
documents.listqueryProperty Management v2

List documents with optional filters and pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/documents.list

Scopes

erp

Arguments

NameTypeRequiredDescription
locationIdstringnoFilter results to documents at this location.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
documents.showqueryProperty Management v2

Show a document by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/documents.show

Scopes

erp

Arguments

NameTypeRequiredDescription
documentstringyesThe document to show, referenced by ID or alias.
documents.typemappingsqueryProperty Management v2

Lists type to category mappings.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/documents.typemappings

Scopes

*

info1 tools

infoqueryProperty Management v2

Returns tenant and integration information.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/info

Scopes

*

objectaddresses4 tools

objectaddresses.createcommandProperty Management v2

Create a new object address.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objectaddresses.create

Scopes

erp

Arguments

NameTypeRequiredDescription
objectAddressobjectyesThe object address data to create.
objectaddresses.updatecommandProperty Management v2

Update an existing object address.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objectaddresses.update

Scopes

erp

Arguments

NameTypeRequiredDescription
objectAddressobjectyesThe object address to update, referenced by ID or alias.
objectaddresses.listqueryProperty Management v2

List object addresses for the current tenant, optionally filtered by object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/objectaddresses.list

Scopes

erp

Arguments

NameTypeRequiredDescription
objectIdstringnoFilter results to the addresses of this object, referenced by its id.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
objectaddresses.showqueryProperty Management v2

Show an object address by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/objectaddresses.show

Scopes

erp

Arguments

NameTypeRequiredDescription
objectAddressstringyesThe object address to show, referenced by ID or alias.

objectgroups3 tools

objectgroups.createcommandProperty Management v2

Create a new object group.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objectgroups.create

Scopes

erp

Arguments

NameTypeRequiredDescription
objectGroupobjectyesThe object group data to create.
objectgroups.updatecommandProperty Management v2

Update an existing object group.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objectgroups.update

Scopes

erp

Arguments

NameTypeRequiredDescription
objectGroupobjectyesThe object group to update, referenced by ID or alias.
objectgroups.showqueryProperty Management v2

Show an object group by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/objectgroups.show

Scopes

erp

Arguments

NameTypeRequiredDescription
objectGroupstringyesThe object group to show, referenced by ID or alias.

objects4 tools

objects.createcommandProperty Management v2

Create a new property object for the current tenant.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objects.create

Scopes

erp

Arguments

NameTypeRequiredDescription
objectobjectyesThe object data to create.
objects.updatecommandProperty Management v2

Update an existing property object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/objects.update

Scopes

erp

Arguments

NameTypeRequiredDescription
objectobjectyesThe object to update, referenced by ID or alias.
objectsqueryProperty Management v2

Lists all property objects for the tenant.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/objects

Scopes

erp
objects.showqueryProperty Management v2

Show a single property object by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/objects.show

Scopes

erp

Arguments

NameTypeRequiredDescription
objectstringyesThe object to show, referenced by ID or alias.

openapi1 tools

openapi.specqueryProperty Management v2

Returns the auto-generated OpenAPI 3.0 spec filtered to endpoints the requesting integration can access.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/openapi.spec

Scopes

*

posts1 tools

posts.showqueryProperty Management v2

Show a post by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/posts.show

Scopes

erp

Arguments

NameTypeRequiredDescription
poststringyesThe post to show, referenced by ID or alias.

processes8 tools

processes.createcommandProperty Management v2

Create a new process under the current property management tenant. Requires a process payload in Create mode (properties without an id) and an object reference that locates the owning property object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/processes.create

Scopes

*

Arguments

NameTypeRequiredDescription
processobjectyesThe process data to create.
objectstringyesThe object the process belongs to, referenced by ID or alias.
processes.updatecommandProperty Management v2

Update an existing process identified by its payload id or alias. The process payload must be in Update mode (id or alias required, plus at least one property field to change).

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/processes.update

Scopes

*

Arguments

NameTypeRequiredDescription
processobjectyesThe process to update, referenced by ID or alias.
processes.updates.createcommandProperty Management v2

Create a process update.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/processes.updates.create

Scopes

*

Arguments

NameTypeRequiredDescription
updateobjectyesThe process update data to create.
processstringyesThe process to add the update to, referenced by ID or alias.
processes.updates.updatecommandProperty Management v2

Update an existing process update identified by its payload id. The process update payload must be in Update mode (id required, plus at least one property field to change).

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/processes.updates.update

Scopes

*

Arguments

NameTypeRequiredDescription
updateobjectyesThe process update to update, referenced by ID.
processes.listqueryProperty Management v2

List processes for the current tenant with pagination. Supports filtering by archive status, associated object, and contract.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/processes.list

Scopes

*

Arguments

NameTypeRequiredDescription
isArchivedbooleannoFilter results to archived or active processes.
objectstringnoThe object to filter processes by, referenced by ID or alias.
contractstringnoFilter results to processes linked to this contract.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
processes.showqueryProperty Management v2

Show a single process by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/processes.show

Scopes

*

Arguments

NameTypeRequiredDescription
processstringyesThe process to show, referenced by ID or alias.
processes.updates.listqueryProperty Management v2

List process updates of a process with pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/processes.updates.list

Scopes

*

Arguments

NameTypeRequiredDescription
processstringyesThe process to list updates for, referenced by ID or alias.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
processes.updates.showqueryProperty Management v2

Show a single process update by id.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/processes.updates.show

Scopes

*

Arguments

NameTypeRequiredDescription
updatestringyesThe process update to show, referenced by ID.

responsibilities3 tools

responsibilities.createcommandProperty Management v2

Create a responsibility linking a contact to an object with a job category.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/responsibilities.create

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
responsibilityobjectyesThe responsibility data to create.
contactstringyesThe contact to link the responsibility to, referenced by ID or alias.
objectstringyesThe object to link the responsibility to, referenced by ID or alias.
responsibilities.updatecommandProperty Management v2

Update an existing responsibility identified by its payload id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/responsibilities.update

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
responsibilityobjectyesThe responsibility to update, referenced by ID or alias.
responsibilities.listqueryProperty Management v2

List responsibilities for the current tenant with optional filters.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/responsibilities.list

Scopes

erpaivoice

Arguments

NameTypeRequiredDescription
contactIdstringnoFilter results to responsibilities for this contact.
objectIdstringnoFilter results to responsibilities for this object.
categoryIdstringnoFilter results to responsibilities with this job category.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.

signatories3 tools

signatories.createcommandProperty Management v2

Create a new signatory.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/signatories.create

Scopes

erp

Arguments

NameTypeRequiredDescription
signatoryobjectyesThe signatory data to create.
signatories.updatecommandProperty Management v2

Update an existing signatory.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/signatories.update

Scopes

erp

Arguments

NameTypeRequiredDescription
signatoryobjectyesThe signatory to update, referenced by ID or alias.
signatories.showqueryProperty Management v2

Show a signatory by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/signatories.show

Scopes

erp

Arguments

NameTypeRequiredDescription
signatorystringyesThe signatory to show, referenced by ID or alias.

status1 tools

statusqueryProperty Management v2

Returns status.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/status

Scopes

*

tenant1 tools

tenantqueryProperty Management v2

Returns the current tenant's data.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/tenant

Scopes

*

unitgroups1 tools

unitgroups.listforobjectqueryProperty Management v2

Lists unit groups.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/unitgroups.listforobject

Scopes

erp

Arguments

NameTypeRequiredDescription
objectstringyesThe object to list unit groups for, referenced by ID or alias.

units4 tools

units.createcommandProperty Management v2

Create a new unit.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/units.create

Scopes

erp

Arguments

NameTypeRequiredDescription
unitobjectyesThe unit data to create.
units.updatecommandProperty Management v2

Update an existing unit.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/units.update

Scopes

erp

Arguments

NameTypeRequiredDescription
unitobjectyesThe unit to update, referenced by ID or alias.
unitsqueryProperty Management v2

List units for the current tenant with optional filters and pagination.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/units

Scopes

erp

Arguments

NameTypeRequiredDescription
objectIdstringnoFilter results to units belonging to this object.
limitintegeryesMaximum number of results to return (1-1000).
offsetintegeryesNumber of results to skip for pagination.
units.showqueryProperty Management v2

Show a unit by id or alias.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

GET /propertymanagement/v2/query/units.show

Scopes

erp

Arguments

NameTypeRequiredDescription
unitstringyesThe unit to show, referenced by ID or alias.

uvi1 tools

uvi.uploadcommandProperty Management v2

Upload a UVI document for an object.

tenant and integration are resolved from the API key. Never pass tenantId as an argument.

Endpoint

POST /propertymanagement/v2/command/uvi.upload

Scopes

erp

Arguments

NameTypeRequiredDescription
dataobjectyesThe UVI upload data including object and category references.
resourceobjectyesThe uploaded file resource to process.