Current RMS MCP by usefulapi
Browse opportunities, products, stock, availability and invoices, and create quotes in Current RMS.
Sollte ich dies verwenden
Qualität und Sicherheit
Befunde (3)
- LOWin current_rms_list_opportunity_items
- LOWin current_rms_list_product_inventories
- LOWin current_rms_check_product_availability
Basierend auf einer automatisierten Analyse der Tool-Definitionen und der Einhaltung des Protokolls.
Kontextkosten
Dies ist die ungefähre Anzahl der Tokens, die jedes Mal verbraucht werden, wenn die Tools des Servers in den Kontext eines Modells geladen werden. Höhere Werte verringern die Aufmerksamkeit, die für andere Aufgaben verfügbar ist.
Installieren
Installation mit einem Klick
Fügen Sie dies Ihrer Datei `claude_desktop_config.json` hinzu:
{
"mcpServers": {
"current-rms": {
"url": "https://current-rms.usefulapi.io/mcp"
}
}
}Remote-Endpunkte
https://current-rms.usefulapi.io/mcpstreamable-httpWas es kann
Tool-Inventar
Tools (20)
🟢current_rms_list_members(search, filtermode, filters, sort, view_id, ...)
List members — Current RMS's single record type for Organisations, Contacts, Venues and Users. Free-text search covers name, street, work phone, work email and tags. Defaults to active records; filtermode can be active, inactive, all, organisation, contact, venue, user, with_pending_activities, with_live_opportunities, bookable. Current RMS: GET /members.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on name, street, work phone, work email, user email or tags.",
"type": "string"
},
"filtermode": {
"description": "Built-in filter, e.g. all, organisation, contact, venue, user, inactive.",
"type": "string"
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_get_member(member_id)
Fetch one member (organisation, contact, venue or user) with its addresses, emails, phones, links, linked parent/child members and custom fields. Current RMS: GET /members/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"member_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The member id."
}
},
"required": [
"member_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_opportunities(search, filtermode, filters, sort, include, ...)
List opportunities — the enquiries, drafts, quotations and orders for a rental job — with their dates, state and charge totals. Free-text search covers subject, description, number, customer name and tags. filtermode e.g. live, all, inactive, enquiries, drafts, quotations, orders, invoiced, not_invoiced, needing_prep. Line items are NOT included here: use current_rms_get_opportunity or current_rms_list_opportunity_items. Max 25 per page. Current RMS: GET /opportunities.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on subject, description, number, customer name or tags.",
"type": "string"
},
"filtermode": {
"description": "Built-in filter, e.g. live, all, quotations, orders, not_invoiced.",
"type": "string"
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"include": {
"description": "Associations to embed in each record.",
"type": "array",
"items": {
"type": "string",
"enum": [
"owner",
"member",
"billing_address",
"destination",
"collection",
"venue",
"opportunity_surcharges"
]
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-25.",
"type": "integer",
"minimum": 1,
"maximum": 25
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_get_opportunity(opportunity_id, include)
Fetch one opportunity with its dates, state (0 Enquiry, 1 Draft, 2 Quotation, 3 Order), status and charge/cost totals. Associations (customer, venue, line items, assets, participants) are only returned when named in include. Current RMS: GET /opportunities/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"opportunity_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The opportunity id."
},
"include": {
"description": "Associations to embed, e.g. [\"member\", \"venue\", \"opportunity_items\"].",
"type": "array",
"items": {
"type": "string",
"enum": [
"owner",
"member",
"billing_address",
"destination",
"collection",
"venue",
"opportunity_surcharges",
"participants",
"opportunity_items",
"item_assets",
"return_item_assets"
]
}
}
},
"required": [
"opportunity_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_opportunity_items(opportunity_id, include, page, per_page)
List the line items on one opportunity — products, services and groups, with quantity, rate, discount, dates and charge totals. Current RMS: GET /opportunities/{opportunity_id}/opportunity_items.
Eingabe-Schema
{
"type": "object",
"properties": {
"opportunity_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The opportunity id."
},
"include": {
"description": "Associations to embed on each line.",
"type": "array",
"items": {
"type": "string",
"enum": [
"item",
"item_assets",
"rate_definition",
"item_surcharges"
]
}
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"opportunity_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_products(search, filtermode, filters, sort, include, ...)
List products (rental and sale items) with their group, stock method, rates, weight and barcode. Free-text search covers name, product group name and tags. filtermode: active (default), inactive, all. Current RMS: GET /products.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on name, product group name or tags.",
"type": "string"
},
"filtermode": {
"description": "Which products to return.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"include": {
"description": "Associations to embed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"accessories"
]
}
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_get_product(product_id, include)
Fetch one product with its rates, stock settings and custom fields. Current RMS: GET /products/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The product id."
},
"include": {
"description": "Associations to embed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"accessories",
"icon",
"product_group"
]
}
}
},
"required": [
"product_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_product_inventories(search, filtermode, store_id, starts_at, ends_at, ...)
Stock snapshot per product: rental quantity held, booked, unavailable, on sub-rent and AVAILABLE, plus sale stock and prices. Pass starts_at/ends_at to compute rental availability for a job's dates instead of today, and store_id to restrict to one store. filtermode: active, inactive, all, rental, sale. Current RMS: GET /product_inventories.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on name, product group name or tags.",
"type": "string"
},
"filtermode": {
"description": "Built-in filter, e.g. rental, sale, all.",
"type": "string"
},
"store_id": {
"description": "Only this store.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"description": "Start of the period to compute rental availability for (UTC).",
"type": "string"
},
"ends_at": {
"description": "End of the period to compute rental availability for (UTC).",
"type": "string"
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_check_product_availability(product_id, starts_at, days_period, store_ids)
Rental availability for ONE product over a date range: arrays of quantity held, booked, unavailable, available, on sub-rent and quoted — one entry per availability period (hour, quarter day, half day or day depending on the range and system setting) — plus the opportunities that book it. Read-only, even though the API uses POST. Current RMS: POST /availability/product.
Eingabe-Schema
{
"type": "object",
"properties": {
"product_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The product id."
},
"starts_at": {
"type": "string",
"description": "Start date, ISO 8601, e.g. 2026-10-01."
},
"days_period": {
"type": "integer",
"minimum": 1,
"maximum": 366,
"description": "Number of days to report on."
},
"store_ids": {
"description": "Only these stores.",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
},
"required": [
"product_id",
"starts_at",
"days_period"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_stock_levels(product_id, filters, sort, include, page, ...)
List stock levels — the individual serialised assets (asset number, serial number, location, store) or bulk stock quantities held. Pass product_id for one product's stock, or use filters such as {"asset_number_eq": "ABC-1234"} to find an asset. Current RMS: GET /stock_levels or GET /products/{product_id}/stock_levels.
Eingabe-Schema
{
"type": "object",
"properties": {
"product_id": {
"description": "Only this product's stock levels.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"include": {
"description": "Associations to embed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"item",
"icon"
]
}
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_stores
List the account's stores (warehouses/depots) with their ids and addresses — needed for store_id when creating an opportunity. Current RMS: GET /stores.
Eingabe-Schema
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_invoices(search, filtermode, filters, sort, include, ...)
List invoices and credit notes with number, dates, status and totals. Free-text search covers subject, number, description, customer name and tags. filtermode: live, inactive, all, invoices, credits. To find one opportunity's invoices pass filters {"invoice_items_source_type_eq": "Opportunity", "invoice_items_source_id_eq": <opportunity id>} with filtermode all. Current RMS: GET /invoices.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on subject, number, description, customer name or tags.",
"type": "string"
},
"filtermode": {
"description": "Built-in filter: live, inactive, all, invoices, credits.",
"type": "string"
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"include": {
"description": "Associations to embed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"owner",
"member",
"billing_address",
"destination",
"venue",
"invoice_taxes",
"tax_class",
"invoice_items"
]
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_get_invoice(invoice_id, include)
Fetch one invoice or credit note with its status, due date and totals; include invoice_items for the lines. Current RMS: GET /invoices/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"invoice_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The invoice id."
},
"include": {
"description": "Associations to embed, e.g. [\"invoice_items\"].",
"type": "array",
"items": {
"type": "string",
"enum": [
"owner",
"member",
"billing_address",
"destination",
"venue",
"invoice_taxes",
"tax_class",
"invoice_items"
]
}
}
},
"required": [
"invoice_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_projects(search, filtermode, filters, sort, view_id, ...)
List projects — groups of related opportunities for one customer or event. Free-text search covers name, customer name and tags. filtermode: active (default), inactive, all. Current RMS: GET /projects.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on name, customer name or tags.",
"type": "string"
},
"filtermode": {
"description": "Which projects to return.",
"type": "string",
"enum": [
"active",
"inactive",
"all"
]
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢current_rms_list_activities(search, filtermode, filters, sort, include, ...)
List activities — calls, meetings, tasks and notes logged against members, opportunities and projects. filtermode: pending, completed, all. Example filters for one person's busy time in a window: {"time_status_eq": 1, "starts_at_lt": "2026-10-02T00:00:00.000Z", "ends_at_gteq": "2026-10-01T00:00:00.000Z", "participants_member_id_eq": [123]}. Current RMS: GET /activities.
Eingabe-Schema
{
"type": "object",
"properties": {
"search": {
"description": "Free-text search on subject, description, location or tags.",
"type": "string"
},
"filtermode": {
"description": "Which activities to return.",
"type": "string",
"enum": [
"pending",
"completed",
"all"
]
},
"filters": {
"description": "Extra Current RMS query-engine predicates, sent as q[<key>]=<value> (arrays become q[<key>][]). Examples: {\"updated_at_gt\": \"2026-01-01T00:00:00.000Z\"}, {\"number_eq\": \"003664\"}, {\"status_not_eq\": 40}, {\"work_email_address_eq\": \"[email protected]\"}, {\"asset_number_eq\": \"ABC-1\"}. Unknown predicates are silently ignored by the API.",
"type": "object",
"propertyNames": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+$"
},
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array",
"items": {
"type": [
"string",
"number"
]
}
}
]
}
},
"sort": {
"description": "Sort order, e.g. [\"name asc\"] or [\"updated_at desc\", \"id asc\"]. Add \"id asc\" when paging so the order is deterministic.",
"type": "array",
"items": {
"type": "string",
"pattern": "^[A-Za-z0-9_]+ (asc|desc)$"
}
},
"include": {
"description": "Associations to embed.",
"type": "array",
"items": {
"type": "string",
"enum": [
"regarding",
"owner",
"opportunity_item_asset",
"participants"
]
}
},
"view_id": {
"description": "Record id of a saved custom view to apply.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"page": {
"description": "Page number, starting at 1.",
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"per_page": {
"description": "Records per page, 1-100 (default 20).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴current_rms_create_member(name, membership_type, description, title, department, ...)
Create an Organisation, Contact or Venue. To link a new Contact to its Organisation, pass parent_member_id. Current RMS: POST /members.
Eingabe-Schema
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "The member's name."
},
"membership_type": {
"type": "string",
"enum": [
"Organisation",
"Contact",
"Venue"
],
"description": "The kind of member."
},
"description": {
"description": "Notes about the member.",
"type": "string"
},
"title": {
"description": "Job title (Contacts only).",
"type": "string"
},
"department": {
"description": "Department (Contacts only).",
"type": "string"
},
"emails": {
"description": "Email addresses to add.",
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Email address."
},
"type_id": {
"description": "Email type list-value id (4001 = Work in a default setup).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"address"
]
}
},
"phones": {
"description": "Phone numbers to add.",
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"type_id": {
"description": "Phone type list-value id (6001 = Work in a default setup).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"number"
]
}
},
"parent_member_id": {
"description": "Organisation (or Venue) member id to link this Contact to.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"tag_list": {
"description": "Tags.",
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom field values by field name.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"name",
"membership_type"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴current_rms_update_member(member_id, name, membership_type, description, active, ...)
Update fields on an existing member. Only the fields you pass are sent. Emails and phones passed here are ADDED (existing ones are kept). When updating custom_fields, also pass the member's membership_type. Current RMS: PUT /members/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"member_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The member id."
},
"name": {
"description": "New name.",
"type": "string",
"minLength": 1
},
"membership_type": {
"description": "The member's EXISTING type — required by the API when updating custom_fields.",
"type": "string",
"enum": [
"Organisation",
"Contact",
"Venue",
"User"
]
},
"description": {
"description": "Notes about the member.",
"type": "string"
},
"active": {
"description": "Set false to make the member inactive (reversible).",
"type": "boolean"
},
"emails": {
"description": "Email addresses to add.",
"type": "array",
"items": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Email address."
},
"type_id": {
"description": "Email type list-value id (4001 = Work in a default setup).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"address"
]
}
},
"phones": {
"description": "Phone numbers to add.",
"type": "array",
"items": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"type_id": {
"description": "Phone type list-value id (6001 = Work in a default setup).",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"number"
]
}
},
"tag_list": {
"description": "Replacement tag list.",
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom field values by field name.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"member_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴current_rms_create_opportunity(store_id, state, subject, description, external_description, ...)
Create an opportunity (a rental job) as an Enquiry, Draft or Quotation. store_id is required (see current_rms_list_stores); set member_id for the customer and starts_at/ends_at for the job dates. Line items are added in Current RMS. Current RMS: POST /opportunities.
Eingabe-Schema
{
"type": "object",
"properties": {
"store_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The store the job is served from."
},
"state": {
"description": "0 = Enquiry, 1 = Draft, 2 = Quotation. Converting to an Order is left to Current RMS.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
}
]
},
"subject": {
"description": "The opportunity's subject (title).",
"type": "string"
},
"description": {
"description": "Internal description.",
"type": "string"
},
"external_description": {
"description": "Description shown on customer documents.",
"type": "string"
},
"member_id": {
"description": "The customer (Organisation/Contact member) id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"billing_address_id": {
"description": "The member's address id used for billing.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"venue_id": {
"description": "The Venue member id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"project_id": {
"description": "The project this opportunity belongs to.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"description": "Overall start / delivery date-time (UTC).",
"type": "string"
},
"ends_at": {
"description": "Overall end / collection date-time (UTC).",
"type": "string"
},
"charge_starts_at": {
"description": "Charging period start (UTC).",
"type": "string"
},
"charge_ends_at": {
"description": "Charging period end (UTC).",
"type": "string"
},
"reference": {
"description": "Customer reference, e.g. their PO number.",
"type": "string"
},
"owned_by": {
"description": "User member id of the owner.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"delivery_instructions": {
"description": "Delivery instructions.",
"type": "string"
},
"collection_instructions": {
"description": "Collection instructions.",
"type": "string"
},
"customer_collecting": {
"description": "The customer collects the goods themselves.",
"type": "boolean"
},
"customer_returning": {
"description": "The customer returns the goods themselves.",
"type": "boolean"
},
"rating": {
"description": "Rating, 0-5.",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"tag_list": {
"description": "Tags.",
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom field values by field name.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"store_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴current_rms_update_opportunity(opportunity_id, store_id, subject, description, external_description, ...)
Update header fields on an existing opportunity — subject, customer, venue, dates, reference, instructions, tags, custom fields. Only the fields you pass are sent. State changes (convert to quote/order, cancel, mark lost) are deliberately not available. Current RMS: PUT /opportunities/{id}.
Eingabe-Schema
{
"type": "object",
"properties": {
"opportunity_id": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"description": "The opportunity id."
},
"store_id": {
"description": "Move the job to another store.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"subject": {
"description": "The opportunity's subject (title).",
"type": "string"
},
"description": {
"description": "Internal description.",
"type": "string"
},
"external_description": {
"description": "Description shown on customer documents.",
"type": "string"
},
"member_id": {
"description": "The customer (Organisation/Contact member) id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"billing_address_id": {
"description": "The member's address id used for billing.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"venue_id": {
"description": "The Venue member id.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"project_id": {
"description": "The project this opportunity belongs to.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"description": "Overall start / delivery date-time (UTC).",
"type": "string"
},
"ends_at": {
"description": "Overall end / collection date-time (UTC).",
"type": "string"
},
"charge_starts_at": {
"description": "Charging period start (UTC).",
"type": "string"
},
"charge_ends_at": {
"description": "Charging period end (UTC).",
"type": "string"
},
"reference": {
"description": "Customer reference, e.g. their PO number.",
"type": "string"
},
"owned_by": {
"description": "User member id of the owner.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"delivery_instructions": {
"description": "Delivery instructions.",
"type": "string"
},
"collection_instructions": {
"description": "Collection instructions.",
"type": "string"
},
"customer_collecting": {
"description": "The customer collects the goods themselves.",
"type": "boolean"
},
"customer_returning": {
"description": "The customer returns the goods themselves.",
"type": "boolean"
},
"rating": {
"description": "Rating, 0-5.",
"type": "integer",
"minimum": 0,
"maximum": 5
},
"tag_list": {
"description": "Tags.",
"type": "array",
"items": {
"type": "string"
}
},
"custom_fields": {
"description": "Custom field values by field name.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
}
},
"required": [
"opportunity_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴current_rms_create_activity(subject, description, location, regarding_type, regarding_id, ...)
Log an activity (call, meeting, task, note) against a member, opportunity or project, optionally with participants. Current RMS: POST /activities.
Eingabe-Schema
{
"type": "object",
"properties": {
"subject": {
"type": "string",
"minLength": 1,
"description": "The activity's subject."
},
"description": {
"description": "Details.",
"type": "string"
},
"location": {
"description": "Where it takes place.",
"type": "string"
},
"regarding_type": {
"description": "The kind of record it concerns, e.g. \"Opportunity\", \"Member\" or \"Project\".",
"type": "string"
},
"regarding_id": {
"description": "The id of that record.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"starts_at": {
"description": "Start (UTC).",
"type": "string"
},
"ends_at": {
"description": "End (UTC).",
"type": "string"
},
"owned_by": {
"description": "User member id of the owner.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"priority": {
"description": "Priority, 1-5.",
"type": "integer",
"minimum": 1,
"maximum": 5
},
"type_id": {
"description": "Activity type list-value id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"status_id": {
"description": "Activity status list-value id.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"completed": {
"description": "Mark as already completed.",
"type": "boolean"
},
"time_status": {
"description": "0 = Free, 1 = Busy.",
"anyOf": [
{
"type": "number",
"const": 0
},
{
"type": "number",
"const": 1
}
]
},
"participant_member_ids": {
"description": "Member ids to add as participants.",
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
}
},
"required": [
"subject"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}Community
Nachweis